com.google.cloud.bigquery.datatransfer.v1

Class TransferConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.datatransfer.v1.TransferConfig

All Implemented Interfaces:

TransferConfigOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class TransferConfig
extends GeneratedMessageV3
implements TransferConfigOrBuilder

 Represents a data transfer configuration. A transfer configuration
 contains all metadata needed to perform a data transfer. For example,
 `destination_dataset_id` specifies where data should be stored.
 When a new transfer configuration is created, the specified
 `destination_dataset_id` is created when needed and shared with the
 appropriate data source service account.
 

Protobuf type google.cloud.bigquery.datatransfer.v1.TransferConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferConfig.Builder Represents a data transfer configuration.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
static int	DATA_SOURCE_ID_FIELD_NUMBER
static int	DATASET_REGION_FIELD_NUMBER
static int	DESTINATION_DATASET_ID_FIELD_NUMBER
static int	DISABLED_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	NEXT_RUN_TIME_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER
static int	SCHEDULE_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER
static int	USER_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getDataRefreshWindowDays() The number of days to look back to automatically refresh the data.
java.lang.String	getDatasetRegion() Output only.
ByteString	getDatasetRegionBytes() Output only.
java.lang.String	getDataSourceId() Data source id.
ByteString	getDataSourceIdBytes() Data source id.
static TransferConfig	getDefaultInstance()
TransferConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getDestinationDatasetId() The BigQuery target dataset id.
ByteString	getDestinationDatasetIdBytes() The BigQuery target dataset id.
boolean	getDisabled() Is this config disabled.
java.lang.String	getDisplayName() User specified display name for the data transfer.
ByteString	getDisplayNameBytes() User specified display name for the data transfer.
java.lang.String	getName() The resource name of the transfer config.
ByteString	getNameBytes() The resource name of the transfer config.
Timestamp	getNextRunTime() Output only.
TimestampOrBuilder	getNextRunTimeOrBuilder() Output only.
Struct	getParams() Data transfer specific parameters.
StructOrBuilder	getParamsOrBuilder() Data transfer specific parameters.
Parser<TransferConfig>	getParserForType()
java.lang.String	getSchedule() Data transfer schedule.
ByteString	getScheduleBytes() Data transfer schedule.
int	getSerializedSize()
TransferState	getState() Output only.
int	getStateValue() Output only.
UnknownFieldSet	getUnknownFields()
Timestamp	getUpdateTime() Output only.
TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
long	getUserId() Output only.
int	hashCode()
boolean	hasNextRunTime() Output only.
boolean	hasParams() Data transfer specific parameters.
boolean	hasUpdateTime() Output only.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TransferConfig.Builder	newBuilder()
static TransferConfig.Builder	newBuilder(TransferConfig prototype)
TransferConfig.Builder	newBuilderForType()
protected TransferConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static TransferConfig	parseDelimitedFrom(java.io.InputStream input)
static TransferConfig	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static TransferConfig	parseFrom(byte[] data)
static TransferConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static TransferConfig	parseFrom(java.nio.ByteBuffer data)
static TransferConfig	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static TransferConfig	parseFrom(ByteString data)
static TransferConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static TransferConfig	parseFrom(CodedInputStream input)
static TransferConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static TransferConfig	parseFrom(java.io.InputStream input)
static TransferConfig	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<TransferConfig>	parser()
TransferConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESTINATION_DATASET_ID_FIELD_NUMBER

public static final int DESTINATION_DATASET_ID_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DATA_SOURCE_ID_FIELD_NUMBER

public static final int DATA_SOURCE_ID_FIELD_NUMBER

See Also:

Constant Field Values

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER

See Also:

Constant Field Values

DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER

public static final int DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER

See Also:

Constant Field Values

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

NEXT_RUN_TIME_FIELD_NUMBER

public static final int NEXT_RUN_TIME_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

DATASET_REGION_FIELD_NUMBER

public static final int DATASET_REGION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public java.lang.String getName()

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.
 

string name = 1;

Specified by:

getName in interface TransferConfigOrBuilder

getNameBytes

public ByteString getNameBytes()

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.
 

string name = 1;

Specified by:

getNameBytes in interface TransferConfigOrBuilder

getDestinationDatasetId

public java.lang.String getDestinationDatasetId()

 The BigQuery target dataset id.
 

string destination_dataset_id = 2;

Specified by:

getDestinationDatasetId in interface TransferConfigOrBuilder

getDestinationDatasetIdBytes

public ByteString getDestinationDatasetIdBytes()

 The BigQuery target dataset id.
 

string destination_dataset_id = 2;

Specified by:

getDestinationDatasetIdBytes in interface TransferConfigOrBuilder

getDisplayName

public java.lang.String getDisplayName()

 User specified display name for the data transfer.
 

string display_name = 3;

Specified by:

getDisplayName in interface TransferConfigOrBuilder

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 User specified display name for the data transfer.
 

string display_name = 3;

Specified by:

getDisplayNameBytes in interface TransferConfigOrBuilder

getDataSourceId

public java.lang.String getDataSourceId()

 Data source id. Cannot be changed once data transfer is created.
 

string data_source_id = 5;

Specified by:

getDataSourceId in interface TransferConfigOrBuilder

getDataSourceIdBytes

public ByteString getDataSourceIdBytes()

 Data source id. Cannot be changed once data transfer is created.
 

string data_source_id = 5;

Specified by:

getDataSourceIdBytes in interface TransferConfigOrBuilder

hasParams

public boolean hasParams()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

Specified by:

hasParams in interface TransferConfigOrBuilder

getParams

public Struct getParams()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

Specified by:

getParams in interface TransferConfigOrBuilder

getParamsOrBuilder

public StructOrBuilder getParamsOrBuilder()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

Specified by:

getParamsOrBuilder in interface TransferConfigOrBuilder

getSchedule

public java.lang.String getSchedule()

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.
 

string schedule = 7;

Specified by:

getSchedule in interface TransferConfigOrBuilder

getScheduleBytes

public ByteString getScheduleBytes()

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.
 

string schedule = 7;

Specified by:

getScheduleBytes in interface TransferConfigOrBuilder

getDataRefreshWindowDays

public int getDataRefreshWindowDays()

 The number of days to look back to automatically refresh the data.
 For example, if `data_refresh_window_days = 10`, then every day
 BigQuery reingests data for [today-10, today-1], rather than ingesting data
 for just [today-1].
 Only valid if the data source supports the feature. Set the value to  0
 to use the default value.
 

int32 data_refresh_window_days = 12;

Specified by:

getDataRefreshWindowDays in interface TransferConfigOrBuilder

getDisabled

public boolean getDisabled()

 Is this config disabled. When set to true, no runs are scheduled
 for a given transfer.
 

bool disabled = 13;

Specified by:

getDisabled in interface TransferConfigOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

hasUpdateTime in interface TransferConfigOrBuilder

getUpdateTime

public Timestamp getUpdateTime()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTime in interface TransferConfigOrBuilder

getUpdateTimeOrBuilder

public TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTimeOrBuilder in interface TransferConfigOrBuilder

hasNextRunTime

public boolean hasNextRunTime()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

Specified by:

hasNextRunTime in interface TransferConfigOrBuilder

getNextRunTime

public Timestamp getNextRunTime()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

Specified by:

getNextRunTime in interface TransferConfigOrBuilder

getNextRunTimeOrBuilder

public TimestampOrBuilder getNextRunTimeOrBuilder()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

Specified by:

getNextRunTimeOrBuilder in interface TransferConfigOrBuilder

getStateValue

public int getStateValue()

 Output only. State of the most recently updated transfer run.
 

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10;

Specified by:

getStateValue in interface TransferConfigOrBuilder

getState

public TransferState getState()

 Output only. State of the most recently updated transfer run.
 

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10;

Specified by:

getState in interface TransferConfigOrBuilder

getUserId

public long getUserId()

 Output only. Unique ID of the user on whose behalf transfer is done.
 Applicable only to data sources that do not support service accounts.
 When set to 0, the data source service account credentials are used.
 May be negative. Note, that this identifier is not stable.
 It may change over time even for the same user.
 

int64 user_id = 11;

Specified by:

getUserId in interface TransferConfigOrBuilder

getDatasetRegion

public java.lang.String getDatasetRegion()

 Output only. Region in which BigQuery dataset is located.
 

string dataset_region = 14;

Specified by:

getDatasetRegion in interface TransferConfigOrBuilder

getDatasetRegionBytes

public ByteString getDatasetRegionBytes()

 Output only. Region in which BigQuery dataset is located.
 

string dataset_region = 14;

Specified by:

getDatasetRegionBytes in interface TransferConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static TransferConfig parseFrom(java.nio.ByteBuffer data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(java.nio.ByteBuffer data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(ByteString data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(ByteString data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(byte[] data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(byte[] data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TransferConfig parseFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static TransferConfig parseFrom(java.io.InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static TransferConfig parseDelimitedFrom(java.io.InputStream input)
                                         throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static TransferConfig parseDelimitedFrom(java.io.InputStream input,
                                                ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static TransferConfig parseFrom(CodedInputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static TransferConfig parseFrom(CodedInputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public TransferConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static TransferConfig.Builder newBuilder()

newBuilder

public static TransferConfig.Builder newBuilder(TransferConfig prototype)

toBuilder

public TransferConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected TransferConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static TransferConfig getDefaultInstance()

parser

public static Parser<TransferConfig> parser()

getParserForType

public Parser<TransferConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public TransferConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder