Class TransferConfig (2.32.0)

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

Static Fields

DATASET_REGION_FIELD_NUMBER

public static final int DATASET_REGION_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER

public static final int DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_SOURCE_ID_FIELD_NUMBER

public static final int DATA_SOURCE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DESTINATION_DATASET_ID_FIELD_NUMBER

public static final int DESTINATION_DATASET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EMAIL_PREFERENCES_FIELD_NUMBER

public static final int EMAIL_PREFERENCES_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIGURATION_FIELD_NUMBER

public static final int ENCRYPTION_CONFIGURATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_RUN_TIME_FIELD_NUMBER

public static final int NEXT_RUN_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

OWNER_INFO_FIELD_NUMBER

public static final int OWNER_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULE_OPTIONS_FIELD_NUMBER

public static final int SCHEDULE_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransferConfig getDefaultInstance()
Returns
TypeDescription
TransferConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransferConfig.Builder newBuilder()
Returns
TypeDescription
TransferConfig.Builder

newBuilder(TransferConfig prototype)

public static TransferConfig.Builder newBuilder(TransferConfig prototype)
Parameter
NameDescription
prototypeTransferConfig
Returns
TypeDescription
TransferConfig.Builder

parseDelimitedFrom(InputStream input)

public static TransferConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransferConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransferConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransferConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransferConfig> parser()
Returns
TypeDescription
Parser<TransferConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
int

The dataRefreshWindowDays.

getDataSourceId()

public String getDataSourceId()

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Returns
TypeDescription
String

The dataSourceId.

getDataSourceIdBytes()

public ByteString getDataSourceIdBytes()

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Returns
TypeDescription
ByteString

The bytes for dataSourceId.

getDatasetRegion()

public String getDatasetRegion()

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The datasetRegion.

getDatasetRegionBytes()

public ByteString getDatasetRegionBytes()

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for datasetRegion.

getDefaultInstanceForType()

public TransferConfig getDefaultInstanceForType()
Returns
TypeDescription
TransferConfig

getDestinationCase()

public TransferConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
TransferConfig.DestinationCase

getDestinationDatasetId()

public String getDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
TypeDescription
String

The destinationDatasetId.

getDestinationDatasetIdBytes()

public ByteString getDestinationDatasetIdBytes()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
TypeDescription
ByteString

The bytes for destinationDatasetId.

getDisabled()

public boolean getDisabled()

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

bool disabled = 13;

Returns
TypeDescription
boolean

The disabled.

getDisplayName()

public String getDisplayName()

User specified display name for the data transfer.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User specified display name for the data transfer.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEmailPreferences()

public EmailPreferences getEmailPreferences()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
TypeDescription
EmailPreferences

The emailPreferences.

getEmailPreferencesOrBuilder()

public EmailPreferencesOrBuilder getEmailPreferencesOrBuilder()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
TypeDescription
EmailPreferencesOrBuilder

getEncryptionConfiguration()

public EncryptionConfiguration getEncryptionConfiguration()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
TypeDescription
EncryptionConfiguration

The encryptionConfiguration.

getEncryptionConfigurationOrBuilder()

public EncryptionConfigurationOrBuilder getEncryptionConfigurationOrBuilder()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
TypeDescription
EncryptionConfigurationOrBuilder

getName()

public String getName()

The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or 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;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or 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;

Returns
TypeDescription
ByteString

The bytes for name.

getNextRunTime()

public Timestamp getNextRunTime()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The nextRunTime.

getNextRunTimeOrBuilder()

public TimestampOrBuilder getNextRunTimeOrBuilder()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getNotificationPubsubTopic()

public String getNotificationPubsubTopic()

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

string notification_pubsub_topic = 15;

Returns
TypeDescription
String

The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public ByteString getNotificationPubsubTopicBytes()

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

string notification_pubsub_topic = 15;

Returns
TypeDescription
ByteString

The bytes for notificationPubsubTopic.

getOwnerInfo()

public UserInfo getOwnerInfo()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
UserInfo

The ownerInfo.

getOwnerInfoOrBuilder()

public UserInfoOrBuilder getOwnerInfoOrBuilder()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
UserInfoOrBuilder

getParams()

public Struct getParams()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
TypeDescription
Struct

The params.

getParamsOrBuilder()

public StructOrBuilder getParamsOrBuilder()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
TypeDescription
StructOrBuilder

getParserForType()

public Parser<TransferConfig> getParserForType()
Returns
TypeDescription
Parser<TransferConfig>
Overrides

getSchedule()

public 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Returns
TypeDescription
String

The schedule.

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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Returns
TypeDescription
ByteString

The bytes for schedule.

getScheduleOptions()

public ScheduleOptions getScheduleOptions()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
TypeDescription
ScheduleOptions

The scheduleOptions.

getScheduleOptionsOrBuilder()

public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
TypeDescription
ScheduleOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public TransferState getState()

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

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TransferState

The state.

getStateValue()

public int getStateValue()

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

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getUserId()

public long getUserId()

Deprecated. Unique ID of the user on whose behalf transfer is done.

int64 user_id = 11;

Returns
TypeDescription
long

The userId.

hasDestinationDatasetId()

public boolean hasDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
TypeDescription
boolean

Whether the destinationDatasetId field is set.

hasEmailPreferences()

public boolean hasEmailPreferences()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
TypeDescription
boolean

Whether the emailPreferences field is set.

hasEncryptionConfiguration()

public boolean hasEncryptionConfiguration()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
TypeDescription
boolean

Whether the encryptionConfiguration field is set.

hasNextRunTime()

public boolean hasNextRunTime()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the nextRunTime field is set.

hasOwnerInfo()

public boolean hasOwnerInfo()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the ownerInfo field is set.

hasParams()

public boolean hasParams()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
TypeDescription
boolean

Whether the params field is set.

hasScheduleOptions()

public boolean hasScheduleOptions()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
TypeDescription
boolean

Whether the scheduleOptions field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransferConfig.Builder newBuilderForType()
Returns
TypeDescription
TransferConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransferConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransferConfig.Builder toBuilder()
Returns
TypeDescription
TransferConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException