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
DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
public static final int DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
Field Value
DATA_SOURCE_ID_FIELD_NUMBER
public static final int DATA_SOURCE_ID_FIELD_NUMBER
Field Value
DESTINATION_DATASET_ID_FIELD_NUMBER
public static final int DESTINATION_DATASET_ID_FIELD_NUMBER
Field Value
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EMAIL_PREFERENCES_FIELD_NUMBER
public static final int EMAIL_PREFERENCES_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NEXT_RUN_TIME_FIELD_NUMBER
public static final int NEXT_RUN_TIME_FIELD_NUMBER
Field Value
NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
OWNER_INFO_FIELD_NUMBER
public static final int OWNER_INFO_FIELD_NUMBER
Field Value
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value
SCHEDULE_OPTIONS_FIELD_NUMBER
public static final int SCHEDULE_OPTIONS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransferConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransferConfig.Builder newBuilder()
Returns
newBuilder(TransferConfig prototype)
public static TransferConfig.Builder newBuilder(TransferConfig prototype)
Parameter
Returns
public static TransferConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransferConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransferConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransferConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransferConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransferConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
| int | The dataRefreshWindowDays.
|
getDataSourceId()
public String getDataSourceId()
Data source id. Cannot be changed once data transfer is created.
string data_source_id = 5;
| Type | Description |
| String | The dataSourceId.
|
getDataSourceIdBytes()
public ByteString getDataSourceIdBytes()
Data source id. Cannot be changed once data transfer is created.
string data_source_id = 5;
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| ByteString | The bytes for datasetRegion.
|
getDefaultInstanceForType()
public TransferConfig getDefaultInstanceForType()
Returns
getDestinationCase()
public TransferConfig.DestinationCase getDestinationCase()
Returns
getDestinationDatasetId()
public String getDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
| String | The destinationDatasetId.
|
getDestinationDatasetIdBytes()
public ByteString getDestinationDatasetIdBytes()
The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
| 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;
| Type | Description |
| boolean | The disabled.
|
getDisplayName()
public String getDisplayName()
User specified display name for the data transfer.
string display_name = 3;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
User specified display name for the data transfer.
string display_name = 3;
| Type | Description |
| 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;
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;
getName()
The resource name of the transfer config.
Transfer config names have the form
projects/{project_id}/locations/{region}/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;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the transfer config.
Transfer config names have the form
projects/{project_id}/locations/{region}/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;
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];
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];
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;
| Type | Description |
| 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;
| Type | Description |
| 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];
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];
getParams()
public Struct getParams()
Returns
| Type | Description |
| Struct | The params.
|
getParamsOrBuilder()
public StructOrBuilder getParamsOrBuilder()
Returns
getParserForType()
public Parser<TransferConfig> getParserForType()
Returns
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;
| Type | Description |
| 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;
getScheduleOptions()
public ScheduleOptions getScheduleOptions()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
getScheduleOptionsOrBuilder()
public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
getSerializedSize()
public int getSerializedSize()
Returns
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
getUserId()
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Type | Description |
| long | The userId.
|
hasDestinationDatasetId()
public boolean hasDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the emailPreferences 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];
| Type | Description |
| 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];
| Type | Description |
| boolean | Whether the ownerInfo field is set.
|
hasParams()
public boolean hasParams()
Returns
| Type | Description |
| 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;
| Type | Description |
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransferConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransferConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
