- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferConfigImplements
TransferConfigOrBuilderStatic Fields
DATASET_REGION_FIELD_NUMBER
public static final int DATASET_REGION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
public static final int DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATA_SOURCE_ID_FIELD_NUMBER
public static final int DATA_SOURCE_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DESTINATION_DATASET_ID_FIELD_NUMBER
public static final int DESTINATION_DATASET_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
EMAIL_PREFERENCES_FIELD_NUMBER
public static final int EMAIL_PREFERENCES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENCRYPTION_CONFIGURATION_FIELD_NUMBER
public static final int ENCRYPTION_CONFIGURATION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NEXT_RUN_TIME_FIELD_NUMBER
public static final int NEXT_RUN_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
OWNER_INFO_FIELD_NUMBER
public static final int OWNER_INFO_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SCHEDULE_OPTIONS_FIELD_NUMBER
public static final int SCHEDULE_OPTIONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SCHEDULE_OPTIONS_V2_FIELD_NUMBER
public static final int SCHEDULE_OPTIONS_V2_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static TransferConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
TransferConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static TransferConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
TransferConfig.Builder |
newBuilder(TransferConfig prototype)
public static TransferConfig.Builder newBuilder(TransferConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype |
TransferConfig |
Returns | |
---|---|
Type | Description |
TransferConfig.Builder |
parseDelimitedFrom(InputStream input)
public static TransferConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static TransferConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static TransferConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static TransferConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static TransferConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static TransferConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<TransferConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<TransferConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for datasetRegion. |
getDefaultInstanceForType()
public TransferConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
TransferConfig |
getDestinationCase()
public TransferConfig.DestinationCase getDestinationCase()
Returns | |
---|---|
Type | Description |
TransferConfig.DestinationCase |
getDestinationDatasetId()
public String getDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;
Returns | |
---|---|
Type | Description |
String |
The destinationDatasetId. |
getDestinationDatasetIdBytes()
public ByteString getDestinationDatasetIdBytes()
The BigQuery target dataset id.
string destination_dataset_id = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for destinationDatasetId. |
getDisabled()
public boolean getDisabled()
Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
bool disabled = 13;
Returns | |
---|---|
Type | Description |
boolean |
The disabled. |
getDisplayName()
public String getDisplayName()
User specified display name for the data transfer.
string display_name = 3;
Returns | |
---|---|
Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
User specified display name for the data transfer.
string display_name = 3;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
EncryptionConfigurationOrBuilder |
getError()
public Status getError()
Output only. Error code with detailed information about reason of the latest config failure.
.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public StatusOrBuilder getErrorOrBuilder()
Output only. Error code with detailed information about reason of the latest config failure.
.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
com.google.rpc.StatusOrBuilder |
getName()
public String getName()
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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_id}/topics/{topic_id}
string notification_pubsub_topic = 15;
Returns | |
---|---|
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_id}/topics/{topic_id}
string notification_pubsub_topic = 15;
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
StructOrBuilder |
getParserForType()
public Parser<TransferConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<TransferConfig> |
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 | |
---|---|
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;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ScheduleOptions |
The scheduleOptions. |
getScheduleOptionsOrBuilder()
public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
Returns | |
---|---|
Type | Description |
ScheduleOptionsOrBuilder |
getScheduleOptionsV2()
public ScheduleOptionsV2 getScheduleOptionsV2()
Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;
Returns | |
---|---|
Type | Description |
ScheduleOptionsV2 |
The scheduleOptionsV2. |
getScheduleOptionsV2OrBuilder()
public ScheduleOptionsV2OrBuilder getScheduleOptionsV2OrBuilder()
Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;
Returns | |
---|---|
Type | Description |
ScheduleOptionsV2OrBuilder |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
TimestampOrBuilder |
getUserId()
public long getUserId()
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
Returns | |
---|---|
Type | Description |
long |
The userId. |
hasDestinationDatasetId()
public boolean hasDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean |
Whether the encryptionConfiguration field is set. |
hasError()
public boolean hasError()
Output only. Error code with detailed information about reason of the latest config failure.
.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the error 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 | |
---|---|
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];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the scheduleOptions field is set. |
hasScheduleOptionsV2()
public boolean hasScheduleOptionsV2()
Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;
Returns | |
---|---|
Type | Description |
boolean |
Whether the scheduleOptionsV2 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 | |
---|---|
Type | Description |
boolean |
Whether the updateTime field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public TransferConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
TransferConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
TransferConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public TransferConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
TransferConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |