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

Class TransferConfig

  • All Implemented Interfaces:
    TransferConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TransferConfig
extends com.google.protobuf.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

    • Field Detail

      • 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

      • SCHEDULE_OPTIONS_FIELD_NUMBER

        public static final int SCHEDULE_OPTIONS_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

      • 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

      • DATASET_REGION_FIELD_NUMBER

        public static final int DATASET_REGION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

        public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EMAIL_PREFERENCES_FIELD_NUMBER

        public static final int EMAIL_PREFERENCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OWNER_INFO_FIELD_NUMBER

        public static final int OWNER_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCRYPTION_CONFIGURATION_FIELD_NUMBER

        public static final int ENCRYPTION_CONFIGURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String 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;
        Specified by:
        getName in interface TransferConfigOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface TransferConfigOrBuilder
        Returns:
        The bytes for name.

      • hasDestinationDatasetId

        public boolean hasDestinationDatasetId()
         The BigQuery target dataset id.
        string destination_dataset_id = 2;
        Specified by:
        hasDestinationDatasetId in interface TransferConfigOrBuilder
        Returns:
        Whether the destinationDatasetId field is set.

      • getDestinationDatasetIdBytes

        public com.google.protobuf.ByteString getDestinationDatasetIdBytes()
         The BigQuery target dataset id.
        string destination_dataset_id = 2;
        Specified by:
        getDestinationDatasetIdBytes in interface TransferConfigOrBuilder
        Returns:
        The bytes for destinationDatasetId.

      • getDisplayName

        public String getDisplayName()
         User specified display name for the data transfer.
        string display_name = 3;
        Specified by:
        getDisplayName in interface TransferConfigOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

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

      • 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;
        Specified by:
        getDataSourceId in interface TransferConfigOrBuilder
        Returns:
        The dataSourceId.

      • getDataSourceIdBytes

        public 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;
        Specified by:
        getDataSourceIdBytes in interface TransferConfigOrBuilder
        Returns:
        The bytes for dataSourceId.

      • 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;
        Specified by:
        hasParams in interface TransferConfigOrBuilder
        Returns:
        Whether the params field is set.

      • getParams

        public 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;
        Specified by:
        getParams in interface TransferConfigOrBuilder
        Returns:
        The params.

      • getParamsOrBuilder

        public 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;
        Specified by:
        getParamsOrBuilder in interface TransferConfigOrBuilder

      • 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;
        Specified by:
        getSchedule in interface TransferConfigOrBuilder
        Returns:
        The schedule.

      • getScheduleBytes

        public 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;
        Specified by:
        getScheduleBytes in interface TransferConfigOrBuilder
        Returns:
        The bytes for schedule.

      • hasScheduleOptions

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

      • getScheduleOptions

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

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

      • 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
        Returns:
        The disabled.

      • 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];
        Specified by:
        hasUpdateTime in interface TransferConfigOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface TransferConfigOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasNextRunTime in interface TransferConfigOrBuilder
        Returns:
        Whether the nextRunTime field is set.

      • getNextRunTime

        public 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];
        Specified by:
        getNextRunTime in interface TransferConfigOrBuilder
        Returns:
        The nextRunTime.

      • getNextRunTimeOrBuilder

        public 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];
        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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface TransferConfigOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface TransferConfigOrBuilder
        Returns:
        The state.

      • getUserId

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

      • getDatasetRegion

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

      • getDatasetRegionBytes

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

      • 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;
        Specified by:
        getNotificationPubsubTopic in interface TransferConfigOrBuilder
        Returns:
        The notificationPubsubTopic.

      • getNotificationPubsubTopicBytes

        public 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}/topics/{topic}`
        string notification_pubsub_topic = 15;
        Specified by:
        getNotificationPubsubTopicBytes in interface TransferConfigOrBuilder
        Returns:
        The bytes for notificationPubsubTopic.

      • 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;
        Specified by:
        hasEmailPreferences in interface TransferConfigOrBuilder
        Returns:
        Whether the emailPreferences field is set.

      • 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;
        Specified by:
        getEmailPreferences in interface TransferConfigOrBuilder
        Returns:
        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;
        Specified by:
        getEmailPreferencesOrBuilder in interface TransferConfigOrBuilder

      • 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];
        Specified by:
        hasOwnerInfo in interface TransferConfigOrBuilder
        Returns:
        Whether the ownerInfo field is set.

      • 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];
        Specified by:
        getOwnerInfo in interface TransferConfigOrBuilder
        Returns:
        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];
        Specified by:
        getOwnerInfoOrBuilder in interface TransferConfigOrBuilder

      • 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;
        Specified by:
        hasEncryptionConfiguration in interface TransferConfigOrBuilder
        Returns:
        Whether the encryptionConfiguration field is set.

      • 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;
        Specified by:
        getEncryptionConfiguration in interface TransferConfigOrBuilder
        Returns:
        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;
        Specified by:
        getEncryptionConfigurationOrBuilder in interface TransferConfigOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TransferConfig parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransferConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TransferConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TransferConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TransferConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static TransferConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<TransferConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<TransferConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TransferConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder