Class TransferConfig.Builder

  • All Implemented Interfaces:
    TransferConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    TransferConfig

    public static final class TransferConfig.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
    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
    • Method Detail

      • 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.Builder<TransferConfig.Builder>
      • clear

        public TransferConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • getDefaultInstanceForType

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

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

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

        public TransferConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • setField

        public TransferConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • clearField

        public TransferConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • clearOneof

        public TransferConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • setRepeatedField

        public TransferConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • addRepeatedField

        public TransferConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • mergeFrom

        public TransferConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferConfig.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • mergeFrom

        public TransferConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferConfig.Builder>
        Throws:
        IOException
      • 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.
      • setName

        public TransferConfig.Builder setName​(String value)
         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;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public TransferConfig.Builder clearName()
         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;
        Returns:
        This builder for chaining.
      • setNameBytes

        public TransferConfig.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDestinationDatasetId

        public TransferConfig.Builder setDestinationDatasetId​(String value)
         The BigQuery target dataset id.
         
        string destination_dataset_id = 2;
        Parameters:
        value - The destinationDatasetId to set.
        Returns:
        This builder for chaining.
      • clearDestinationDatasetId

        public TransferConfig.Builder clearDestinationDatasetId()
         The BigQuery target dataset id.
         
        string destination_dataset_id = 2;
        Returns:
        This builder for chaining.
      • setDestinationDatasetIdBytes

        public TransferConfig.Builder setDestinationDatasetIdBytes​(com.google.protobuf.ByteString value)
         The BigQuery target dataset id.
         
        string destination_dataset_id = 2;
        Parameters:
        value - The bytes for destinationDatasetId to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDisplayName

        public TransferConfig.Builder setDisplayName​(String value)
         User specified display name for the data transfer.
         
        string display_name = 3;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.
      • clearDisplayName

        public TransferConfig.Builder clearDisplayName()
         User specified display name for the data transfer.
         
        string display_name = 3;
        Returns:
        This builder for chaining.
      • setDisplayNameBytes

        public TransferConfig.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         User specified display name for the data transfer.
         
        string display_name = 3;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDataSourceId

        public TransferConfig.Builder setDataSourceId​(String value)
         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;
        Parameters:
        value - The dataSourceId to set.
        Returns:
        This builder for chaining.
      • clearDataSourceId

        public TransferConfig.Builder clearDataSourceId()
         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:
        This builder for chaining.
      • setDataSourceIdBytes

        public TransferConfig.Builder setDataSourceIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for dataSourceId to set.
        Returns:
        This builder for chaining.
      • 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.
      • setParams

        public TransferConfig.Builder setParams​(com.google.protobuf.Struct value)
         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;
      • setParams

        public TransferConfig.Builder setParams​(com.google.protobuf.Struct.Builder builderForValue)
         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;
      • mergeParams

        public TransferConfig.Builder mergeParams​(com.google.protobuf.Struct value)
         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;
      • clearParams

        public TransferConfig.Builder clearParams()
         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;
      • getParamsBuilder

        public com.google.protobuf.Struct.Builder getParamsBuilder()
         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;
      • 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.
      • setSchedule

        public TransferConfig.Builder setSchedule​(String value)
         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;
        Parameters:
        value - The schedule to set.
        Returns:
        This builder for chaining.
      • clearSchedule

        public TransferConfig.Builder clearSchedule()
         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:
        This builder for chaining.
      • setScheduleBytes

        public TransferConfig.Builder setScheduleBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for schedule to set.
        Returns:
        This builder for chaining.
      • 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.
      • setScheduleOptions

        public TransferConfig.Builder setScheduleOptions​(ScheduleOptions value)
         Options customizing the data transfer schedule.
         
        .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      • setScheduleOptions

        public TransferConfig.Builder setScheduleOptions​(ScheduleOptions.Builder builderForValue)
         Options customizing the data transfer schedule.
         
        .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      • mergeScheduleOptions

        public TransferConfig.Builder mergeScheduleOptions​(ScheduleOptions value)
         Options customizing the data transfer schedule.
         
        .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      • clearScheduleOptions

        public TransferConfig.Builder clearScheduleOptions()
         Options customizing the data transfer schedule.
         
        .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      • getScheduleOptionsBuilder

        public ScheduleOptions.Builder getScheduleOptionsBuilder()
         Options customizing the data transfer schedule.
         
        .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
      • 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.
      • setDataRefreshWindowDays

        public TransferConfig.Builder setDataRefreshWindowDays​(int value)
         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;
        Parameters:
        value - The dataRefreshWindowDays to set.
        Returns:
        This builder for chaining.
      • clearDataRefreshWindowDays

        public TransferConfig.Builder clearDataRefreshWindowDays()
         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:
        This builder for chaining.
      • 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.
      • setDisabled

        public TransferConfig.Builder setDisabled​(boolean value)
         Is this config disabled. When set to true, no runs are scheduled
         for a given transfer.
         
        bool disabled = 13;
        Parameters:
        value - The disabled to set.
        Returns:
        This builder for chaining.
      • clearDisabled

        public TransferConfig.Builder clearDisabled()
         Is this config disabled. When set to true, no runs are scheduled
         for a given transfer.
         
        bool disabled = 13;
        Returns:
        This builder for chaining.
      • 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.
      • setUpdateTime

        public TransferConfig.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Data transfer modification time. Ignored by server on input.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setUpdateTime

        public TransferConfig.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Data transfer modification time. Ignored by server on input.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeUpdateTime

        public TransferConfig.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Data transfer modification time. Ignored by server on input.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearUpdateTime

        public TransferConfig.Builder clearUpdateTime()
         Output only. Data transfer modification time. Ignored by server on input.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         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 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.
      • setNextRunTime

        public TransferConfig.Builder setNextRunTime​(com.google.protobuf.Timestamp value)
         Output only. Next time when data transfer will run.
         
        .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setNextRunTime

        public TransferConfig.Builder setNextRunTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Next time when data transfer will run.
         
        .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeNextRunTime

        public TransferConfig.Builder mergeNextRunTime​(com.google.protobuf.Timestamp value)
         Output only. Next time when data transfer will run.
         
        .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearNextRunTime

        public TransferConfig.Builder clearNextRunTime()
         Output only. Next time when data transfer will run.
         
        .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getNextRunTimeBuilder

        public com.google.protobuf.Timestamp.Builder getNextRunTimeBuilder()
         Output only. Next time when data transfer will run.
         
        .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • 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.
      • setStateValue

        public TransferConfig.Builder setStateValue​(int value)
         Output only. State of the most recently updated transfer run.
         
        .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.
      • 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.
      • setState

        public TransferConfig.Builder setState​(TransferState value)
         Output only. State of the most recently updated transfer run.
         
        .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.
      • clearState

        public TransferConfig.Builder clearState()
         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:
        This builder for chaining.
      • 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.
      • setUserId

        public TransferConfig.Builder setUserId​(long value)
         Deprecated. Unique ID of the user on whose behalf transfer is done.
         
        int64 user_id = 11;
        Parameters:
        value - The userId to set.
        Returns:
        This builder for chaining.
      • clearUserId

        public TransferConfig.Builder clearUserId()
         Deprecated. Unique ID of the user on whose behalf transfer is done.
         
        int64 user_id = 11;
        Returns:
        This builder for chaining.
      • 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.
      • setDatasetRegion

        public TransferConfig.Builder setDatasetRegion​(String value)
         Output only. Region in which BigQuery dataset is located.
         
        string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The datasetRegion to set.
        Returns:
        This builder for chaining.
      • clearDatasetRegion

        public TransferConfig.Builder clearDatasetRegion()
         Output only. Region in which BigQuery dataset is located.
         
        string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setDatasetRegionBytes

        public TransferConfig.Builder setDatasetRegionBytes​(com.google.protobuf.ByteString value)
         Output only. Region in which BigQuery dataset is located.
         
        string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for datasetRegion to set.
        Returns:
        This builder for chaining.
      • 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.
      • setNotificationPubsubTopic

        public TransferConfig.Builder setNotificationPubsubTopic​(String value)
         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;
        Parameters:
        value - The notificationPubsubTopic to set.
        Returns:
        This builder for chaining.
      • clearNotificationPubsubTopic

        public TransferConfig.Builder clearNotificationPubsubTopic()
         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:
        This builder for chaining.
      • setNotificationPubsubTopicBytes

        public TransferConfig.Builder setNotificationPubsubTopicBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for notificationPubsubTopic to set.
        Returns:
        This builder for chaining.
      • 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.
      • setEmailPreferences

        public TransferConfig.Builder setEmailPreferences​(EmailPreferences value)
         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;
      • setEmailPreferences

        public TransferConfig.Builder setEmailPreferences​(EmailPreferences.Builder builderForValue)
         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;
      • mergeEmailPreferences

        public TransferConfig.Builder mergeEmailPreferences​(EmailPreferences value)
         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;
      • clearEmailPreferences

        public TransferConfig.Builder clearEmailPreferences()
         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;
      • getEmailPreferencesBuilder

        public EmailPreferences.Builder getEmailPreferencesBuilder()
         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;
        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.
      • setOwnerInfo

        public TransferConfig.Builder setOwnerInfo​(UserInfo value)
         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];
      • setOwnerInfo

        public TransferConfig.Builder setOwnerInfo​(UserInfo.Builder builderForValue)
         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];
      • mergeOwnerInfo

        public TransferConfig.Builder mergeOwnerInfo​(UserInfo value)
         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];
      • clearOwnerInfo

        public TransferConfig.Builder clearOwnerInfo()
         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];
      • getOwnerInfoBuilder

        public UserInfo.Builder getOwnerInfoBuilder()
         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];
        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.
      • setEncryptionConfiguration

        public TransferConfig.Builder setEncryptionConfiguration​(EncryptionConfiguration value)
         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;
      • setEncryptionConfiguration

        public TransferConfig.Builder setEncryptionConfiguration​(EncryptionConfiguration.Builder builderForValue)
         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;
      • mergeEncryptionConfiguration

        public TransferConfig.Builder mergeEncryptionConfiguration​(EncryptionConfiguration value)
         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;
      • clearEncryptionConfiguration

        public TransferConfig.Builder clearEncryptionConfiguration()
         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;
      • getEncryptionConfigurationBuilder

        public EncryptionConfiguration.Builder getEncryptionConfigurationBuilder()
         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;
      • 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
      • setUnknownFields

        public final TransferConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
      • mergeUnknownFields

        public final TransferConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>