Package com.google.cloud.bigquery.datatransfer.v1

Interface TransferConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransferConfig, TransferConfig.Builder
@Generated public interface TransferConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • hasDestinationDatasetId

      boolean hasDestinationDatasetId()
       The BigQuery target dataset id.
      string destination_dataset_id = 2;
      Returns:
      Whether the destinationDatasetId field is set.

    • getDestinationDatasetId

      String getDestinationDatasetId()
       The BigQuery target dataset id.
      string destination_dataset_id = 2;
      Returns:
      The destinationDatasetId.

    • getDestinationDatasetIdBytes

      com.google.protobuf.ByteString getDestinationDatasetIdBytes()
       The BigQuery target dataset id.
      string destination_dataset_id = 2;
      Returns:
      The bytes for destinationDatasetId.

    • getDisplayName

      String getDisplayName()
       User specified display name for the data transfer.
      string display_name = 3;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       User specified display name for the data transfer.
      string display_name = 3;
      Returns:
      The bytes for displayName.

    • getDataSourceId

      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:
      The dataSourceId.

    • getDataSourceIdBytes

      com.google.protobuf.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:
      The bytes for dataSourceId.

    • hasParams

      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:
      Whether the params field is set.

    • getParams

      com.google.protobuf.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:
      The params.

    • getParamsOrBuilder

      com.google.protobuf.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;

    • getSchedule

      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:
      The schedule.

    • getScheduleBytes

      com.google.protobuf.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:
      The bytes for schedule.

    • hasScheduleOptions

      boolean hasScheduleOptions()
       Options customizing the data transfer schedule.
      .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      Returns:
      Whether the scheduleOptions field is set.

    • getScheduleOptions

      ScheduleOptions getScheduleOptions()
       Options customizing the data transfer schedule.
      .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      Returns:
      The scheduleOptions.

    • getScheduleOptionsOrBuilder

      ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()
       Options customizing the data transfer schedule.
      .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

    • hasScheduleOptionsV2

      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:
      Whether the scheduleOptionsV2 field is set.

    • getScheduleOptionsV2

      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:
      The scheduleOptionsV2.

    • getScheduleOptionsV2OrBuilder

      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;

    • getDataRefreshWindowDays

      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:
      The dataRefreshWindowDays.

    • getDisabled

      boolean getDisabled()
       Is this config disabled. When set to true, no runs will be scheduled for
 this transfer config.
      bool disabled = 13;
      Returns:
      The disabled.

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.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];

    • hasNextRunTime

      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:
      Whether the nextRunTime field is set.

    • getNextRunTime

      com.google.protobuf.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:
      The nextRunTime.

    • getNextRunTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getNextRunTimeOrBuilder()
       Output only. Next time when data transfer will run.
      .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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:
      The state.

    • getUserId

      long getUserId()
       Deprecated. Unique ID of the user on whose behalf transfer is done.
      int64 user_id = 11;
      Returns:
      The userId.

    • getDatasetRegion

      String getDatasetRegion()
       Output only. Region in which BigQuery dataset is located.
      string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The datasetRegion.

    • getDatasetRegionBytes

      com.google.protobuf.ByteString getDatasetRegionBytes()
       Output only. Region in which BigQuery dataset is located.
      string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for datasetRegion.

    • getNotificationPubsubTopic

      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:
      The notificationPubsubTopic.

    • getNotificationPubsubTopicBytes

      com.google.protobuf.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:
      The bytes for notificationPubsubTopic.

    • hasEmailPreferences

      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:
      Whether the emailPreferences field is set.

    • getEmailPreferences

      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:
      The emailPreferences.

    • getEmailPreferencesOrBuilder

      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;

    • hasOwnerInfo

      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:
      Whether the ownerInfo field is set.

    • getOwnerInfo

      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:
      The ownerInfo.

    • getOwnerInfoOrBuilder

      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];

    • hasEncryptionConfiguration

      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:
      Whether the encryptionConfiguration field is set.

    • getEncryptionConfiguration

      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:
      The encryptionConfiguration.

    • getEncryptionConfigurationOrBuilder

      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;

    • hasError

      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:
      Whether the error field is set.

    • getError

      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:
      The error.

    • getErrorOrBuilder

      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];

    • getDestinationCase

      TransferConfig.DestinationCase getDestinationCase()