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

Class DataSourceDefinition

  • All Implemented Interfaces:
    DataSourceDefinitionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataSourceDefinition
extends com.google.protobuf.GeneratedMessageV3
implements DataSourceDefinitionOrBuilder
     Represents the data source definition.
    Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceDefinition
    See Also:
    Serialized Form

    • Field Detail

      • DATA_SOURCE_FIELD_NUMBER

        public static final int DATA_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER

        public static final int TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_TIME_OFFSET_FIELD_NUMBER

        public static final int RUN_TIME_OFFSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORT_EMAIL_FIELD_NUMBER

        public static final int SUPPORT_EMAIL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER

        public static final int TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORTED_LOCATION_IDS_FIELD_NUMBER

        public static final int SUPPORTED_LOCATION_IDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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 data source definition.
 Data source definition names have the form
 `projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}`.
        string name = 21;
        Specified by:
        getName in interface DataSourceDefinitionOrBuilder

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the data source definition.
 Data source definition names have the form
 `projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}`.
        string name = 21;
        Specified by:
        getNameBytes in interface DataSourceDefinitionOrBuilder

      • hasDataSource

        public boolean hasDataSource()
         Data source metadata.
        .google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;
        Specified by:
        hasDataSource in interface DataSourceDefinitionOrBuilder

      • getTransferRunPubsubTopic

        public String getTransferRunPubsubTopic()
         The Pub/Sub topic to be used for broadcasting a message when a transfer run
 is created. Both this topic and transfer_config_pubsub_topic can be
 set to a custom topic. By default, both topics are auto-generated if none
 of them is provided when creating the definition. However, if one topic is
 manually set, the other topic has to be manually set as well. The only
 difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub
 topic, but transfer_config_pubsub_topic can be set to empty. The comments
 about "{location}" for transfer_config_pubsub_topic apply here too.
        string transfer_run_pubsub_topic = 13;
        Specified by:
        getTransferRunPubsubTopic in interface DataSourceDefinitionOrBuilder

      • getTransferRunPubsubTopicBytes

        public com.google.protobuf.ByteString getTransferRunPubsubTopicBytes()
         The Pub/Sub topic to be used for broadcasting a message when a transfer run
 is created. Both this topic and transfer_config_pubsub_topic can be
 set to a custom topic. By default, both topics are auto-generated if none
 of them is provided when creating the definition. However, if one topic is
 manually set, the other topic has to be manually set as well. The only
 difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub
 topic, but transfer_config_pubsub_topic can be set to empty. The comments
 about "{location}" for transfer_config_pubsub_topic apply here too.
        string transfer_run_pubsub_topic = 13;
        Specified by:
        getTransferRunPubsubTopicBytes in interface DataSourceDefinitionOrBuilder

      • hasRunTimeOffset

        public boolean hasRunTimeOffset()
         Duration which should be added to schedule_time to calculate
 run_time when job is scheduled. Only applicable for automatically
 scheduled transfer runs. Used to start a run early on a data source that
 supports continuous data refresh to compensate for unknown timezone
 offsets. Use a negative number to start a run late for data sources not
 supporting continuous data refresh.
        .google.protobuf.Duration run_time_offset = 16;
        Specified by:
        hasRunTimeOffset in interface DataSourceDefinitionOrBuilder

      • getRunTimeOffset

        public com.google.protobuf.Duration getRunTimeOffset()
         Duration which should be added to schedule_time to calculate
 run_time when job is scheduled. Only applicable for automatically
 scheduled transfer runs. Used to start a run early on a data source that
 supports continuous data refresh to compensate for unknown timezone
 offsets. Use a negative number to start a run late for data sources not
 supporting continuous data refresh.
        .google.protobuf.Duration run_time_offset = 16;
        Specified by:
        getRunTimeOffset in interface DataSourceDefinitionOrBuilder

      • getRunTimeOffsetOrBuilder

        public com.google.protobuf.DurationOrBuilder getRunTimeOffsetOrBuilder()
         Duration which should be added to schedule_time to calculate
 run_time when job is scheduled. Only applicable for automatically
 scheduled transfer runs. Used to start a run early on a data source that
 supports continuous data refresh to compensate for unknown timezone
 offsets. Use a negative number to start a run late for data sources not
 supporting continuous data refresh.
        .google.protobuf.Duration run_time_offset = 16;
        Specified by:
        getRunTimeOffsetOrBuilder in interface DataSourceDefinitionOrBuilder

      • getSupportEmailBytes

        public com.google.protobuf.ByteString getSupportEmailBytes()
         Support e-mail address of the OAuth client's Brand, which contains the
 consent screen data.
        string support_email = 22;
        Specified by:
        getSupportEmailBytes in interface DataSourceDefinitionOrBuilder

      • getServiceAccount

        public String getServiceAccount()
         When service account is specified, BigQuery will share created dataset
 with the given service account. Also, this service account will be
 eligible to perform status updates and message logging for data transfer
 runs for the corresponding data_source_id.
        string service_account = 2;
        Specified by:
        getServiceAccount in interface DataSourceDefinitionOrBuilder

      • getServiceAccountBytes

        public com.google.protobuf.ByteString getServiceAccountBytes()
         When service account is specified, BigQuery will share created dataset
 with the given service account. Also, this service account will be
 eligible to perform status updates and message logging for data transfer
 runs for the corresponding data_source_id.
        string service_account = 2;
        Specified by:
        getServiceAccountBytes in interface DataSourceDefinitionOrBuilder

      • getDisabled

        public boolean getDisabled()
         Is data source disabled? If true, data_source is not visible.
 API will also stop returning any data transfer configs and/or runs
 associated with the data source. This setting has higher priority
 than whitelisted_project_ids.
        bool disabled = 5;
        Specified by:
        getDisabled in interface DataSourceDefinitionOrBuilder

      • getTransferConfigPubsubTopic

        public String getTransferConfigPubsubTopic()
         The Pub/Sub topic to use for broadcasting a message for transfer config. If
 empty, a message will not be broadcasted. Both this topic and
 transfer_run_pubsub_topic are auto-generated if none of them is provided
 when creating the definition. It is recommended to provide
 transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is
 provided. Otherwise, it will be set to empty. If "{location}" is found in
 the value, then that means, data source wants to handle message separately
 for datasets in different regions. We will replace {location} with the
 actual dataset location, as the actual topic name. For example,
 projects/connector/topics/scheduler-{location} could become
 projects/connector/topics/scheduler-us. If "{location}" is not found, then
 we will use the input value as topic name.
        string transfer_config_pubsub_topic = 12;
        Specified by:
        getTransferConfigPubsubTopic in interface DataSourceDefinitionOrBuilder

      • getTransferConfigPubsubTopicBytes

        public com.google.protobuf.ByteString getTransferConfigPubsubTopicBytes()
         The Pub/Sub topic to use for broadcasting a message for transfer config. If
 empty, a message will not be broadcasted. Both this topic and
 transfer_run_pubsub_topic are auto-generated if none of them is provided
 when creating the definition. It is recommended to provide
 transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is
 provided. Otherwise, it will be set to empty. If "{location}" is found in
 the value, then that means, data source wants to handle message separately
 for datasets in different regions. We will replace {location} with the
 actual dataset location, as the actual topic name. For example,
 projects/connector/topics/scheduler-{location} could become
 projects/connector/topics/scheduler-us. If "{location}" is not found, then
 we will use the input value as topic name.
        string transfer_config_pubsub_topic = 12;
        Specified by:
        getTransferConfigPubsubTopicBytes in interface DataSourceDefinitionOrBuilder

      • getSupportedLocationIdsList

        public com.google.protobuf.ProtocolStringList getSupportedLocationIdsList()
         Supported location_ids used for deciding in which locations Pub/Sub topics
 need to be created. If custom Pub/Sub topics are used and they contains
 '{location}', the location_ids will be used for validating the topics by
 replacing the '{location}' with the individual location in the list. The
 valid values are the "location_id" field of the response of `GET
 https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations`
 In addition, if the data source needs to support all available regions,
 supported_location_ids can be set to "global" (a single string element).
 When "global" is specified:
 1) the data source implementation is supposed to stage the data in proper
 region of the destination dataset;
 2) Data source developer should be aware of the implications (e.g., network
 traffic latency, potential charge associated with cross-region traffic,
 etc.) of supporting the "global" region;
        repeated string supported_location_ids = 23;
        Specified by:
        getSupportedLocationIdsList in interface DataSourceDefinitionOrBuilder

      • getSupportedLocationIdsCount

        public int getSupportedLocationIdsCount()
         Supported location_ids used for deciding in which locations Pub/Sub topics
 need to be created. If custom Pub/Sub topics are used and they contains
 '{location}', the location_ids will be used for validating the topics by
 replacing the '{location}' with the individual location in the list. The
 valid values are the "location_id" field of the response of `GET
 https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations`
 In addition, if the data source needs to support all available regions,
 supported_location_ids can be set to "global" (a single string element).
 When "global" is specified:
 1) the data source implementation is supposed to stage the data in proper
 region of the destination dataset;
 2) Data source developer should be aware of the implications (e.g., network
 traffic latency, potential charge associated with cross-region traffic,
 etc.) of supporting the "global" region;
        repeated string supported_location_ids = 23;
        Specified by:
        getSupportedLocationIdsCount in interface DataSourceDefinitionOrBuilder

      • getSupportedLocationIds

        public String getSupportedLocationIds​(int index)
         Supported location_ids used for deciding in which locations Pub/Sub topics
 need to be created. If custom Pub/Sub topics are used and they contains
 '{location}', the location_ids will be used for validating the topics by
 replacing the '{location}' with the individual location in the list. The
 valid values are the "location_id" field of the response of `GET
 https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations`
 In addition, if the data source needs to support all available regions,
 supported_location_ids can be set to "global" (a single string element).
 When "global" is specified:
 1) the data source implementation is supposed to stage the data in proper
 region of the destination dataset;
 2) Data source developer should be aware of the implications (e.g., network
 traffic latency, potential charge associated with cross-region traffic,
 etc.) of supporting the "global" region;
        repeated string supported_location_ids = 23;
        Specified by:
        getSupportedLocationIds in interface DataSourceDefinitionOrBuilder

      • getSupportedLocationIdsBytes

        public com.google.protobuf.ByteString getSupportedLocationIdsBytes​(int index)
         Supported location_ids used for deciding in which locations Pub/Sub topics
 need to be created. If custom Pub/Sub topics are used and they contains
 '{location}', the location_ids will be used for validating the topics by
 replacing the '{location}' with the individual location in the list. The
 valid values are the "location_id" field of the response of `GET
 https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations`
 In addition, if the data source needs to support all available regions,
 supported_location_ids can be set to "global" (a single string element).
 When "global" is specified:
 1) the data source implementation is supposed to stage the data in proper
 region of the destination dataset;
 2) Data source developer should be aware of the implications (e.g., network
 traffic latency, potential charge associated with cross-region traffic,
 etc.) of supporting the "global" region;
        repeated string supported_location_ids = 23;
        Specified by:
        getSupportedLocationIdsBytes in interface DataSourceDefinitionOrBuilder

      • 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 DataSourceDefinition parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<DataSourceDefinition> 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 DataSourceDefinition getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder