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

Class DataSource

  • All Implemented Interfaces:
    DataSourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataSource
extends com.google.protobuf.GeneratedMessageV3
implements DataSourceOrBuilder
     Defines the properties and custom parameters for a data source.
    Protobuf type google.cloud.bigquery.datatransfer.v1.DataSource
    See Also:
    Serialized Form

    • Field Detail

      • DATA_SOURCE_ID_FIELD_NUMBER

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

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFER_TYPE_FIELD_NUMBER

        public static final int TRANSFER_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER

        public static final int SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_DEADLINE_SECONDS_FIELD_NUMBER

        public static final int UPDATE_DEADLINE_SECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_SCHEDULE_FIELD_NUMBER

        public static final int DEFAULT_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER

        public static final int SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTHORIZATION_TYPE_FIELD_NUMBER

        public static final int AUTHORIZATION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_REFRESH_TYPE_FIELD_NUMBER

        public static final int DATA_REFRESH_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER

        public static final int DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MANUAL_RUNS_DISABLED_FIELD_NUMBER

        public static final int MANUAL_RUNS_DISABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER

        public static final int MINIMUM_SCHEDULE_INTERVAL_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()
         Output only. Data source resource name.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface DataSourceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Data source resource name.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for name.

      • getDataSourceIdBytes

        public com.google.protobuf.ByteString getDataSourceIdBytes()
         Data source id.
        string data_source_id = 2;
        Specified by:
        getDataSourceIdBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for dataSourceId.

      • getDisplayName

        public String getDisplayName()
         User friendly data source name.
        string display_name = 3;
        Specified by:
        getDisplayName in interface DataSourceOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         User friendly data source name.
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         User friendly data source description string.
        string description = 4;
        Specified by:
        getDescription in interface DataSourceOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         User friendly data source description string.
        string description = 4;
        Specified by:
        getDescriptionBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for description.

      • getClientId

        public String getClientId()
         Data source client id which should be used to receive refresh token.
        string client_id = 5;
        Specified by:
        getClientId in interface DataSourceOrBuilder
        Returns:
        The clientId.

      • getClientIdBytes

        public com.google.protobuf.ByteString getClientIdBytes()
         Data source client id which should be used to receive refresh token.
        string client_id = 5;
        Specified by:
        getClientIdBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for clientId.

      • getScopesList

        public com.google.protobuf.ProtocolStringList getScopesList()
         Api auth scopes for which refresh token needs to be obtained. These are
 scopes needed by a data source to prepare data and ingest them into
 BigQuery, e.g., https://www.googleapis.com/auth/bigquery
        repeated string scopes = 6;
        Specified by:
        getScopesList in interface DataSourceOrBuilder
        Returns:
        A list containing the scopes.

      • getScopesCount

        public int getScopesCount()
         Api auth scopes for which refresh token needs to be obtained. These are
 scopes needed by a data source to prepare data and ingest them into
 BigQuery, e.g., https://www.googleapis.com/auth/bigquery
        repeated string scopes = 6;
        Specified by:
        getScopesCount in interface DataSourceOrBuilder
        Returns:
        The count of scopes.

      • getScopes

        public String getScopes​(int index)
         Api auth scopes for which refresh token needs to be obtained. These are
 scopes needed by a data source to prepare data and ingest them into
 BigQuery, e.g., https://www.googleapis.com/auth/bigquery
        repeated string scopes = 6;
        Specified by:
        getScopes in interface DataSourceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The scopes at the given index.

      • getScopesBytes

        public com.google.protobuf.ByteString getScopesBytes​(int index)
         Api auth scopes for which refresh token needs to be obtained. These are
 scopes needed by a data source to prepare data and ingest them into
 BigQuery, e.g., https://www.googleapis.com/auth/bigquery
        repeated string scopes = 6;
        Specified by:
        getScopesBytes in interface DataSourceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the scopes at the given index.

      • getTransferTypeValue

        @Deprecated
public int getTransferTypeValue()
        Deprecated.
        google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
         Deprecated. This field has no effect.
        .google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
        Specified by:
        getTransferTypeValue in interface DataSourceOrBuilder
        Returns:
        The enum numeric value on the wire for transferType.

      • getTransferType

        @Deprecated
public TransferType getTransferType()
        Deprecated.
        google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
         Deprecated. This field has no effect.
        .google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
        Specified by:
        getTransferType in interface DataSourceOrBuilder
        Returns:
        The transferType.

      • getSupportsMultipleTransfers

        @Deprecated
public boolean getSupportsMultipleTransfers()
        Deprecated.
        google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=386
         Deprecated. This field has no effect.
        bool supports_multiple_transfers = 8 [deprecated = true];
        Specified by:
        getSupportsMultipleTransfers in interface DataSourceOrBuilder
        Returns:
        The supportsMultipleTransfers.

      • getUpdateDeadlineSeconds

        public int getUpdateDeadlineSeconds()
         The number of seconds to wait for an update from the data source
 before the Data Transfer Service marks the transfer as FAILED.
        int32 update_deadline_seconds = 9;
        Specified by:
        getUpdateDeadlineSeconds in interface DataSourceOrBuilder
        Returns:
        The updateDeadlineSeconds.

      • getDefaultSchedule

        public String getDefaultSchedule()
         Default data transfer schedule.
 Examples of valid schedules include:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
        string default_schedule = 10;
        Specified by:
        getDefaultSchedule in interface DataSourceOrBuilder
        Returns:
        The defaultSchedule.

      • getDefaultScheduleBytes

        public com.google.protobuf.ByteString getDefaultScheduleBytes()
         Default data transfer schedule.
 Examples of valid schedules include:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
        string default_schedule = 10;
        Specified by:
        getDefaultScheduleBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for defaultSchedule.

      • getSupportsCustomSchedule

        public boolean getSupportsCustomSchedule()
         Specifies whether the data source supports a user defined schedule, or
 operates on the default schedule.
 When set to `true`, user can override default schedule.
        bool supports_custom_schedule = 11;
        Specified by:
        getSupportsCustomSchedule in interface DataSourceOrBuilder
        Returns:
        The supportsCustomSchedule.

      • getParametersCount

        public int getParametersCount()
         Data source parameters.
        repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
        Specified by:
        getParametersCount in interface DataSourceOrBuilder

      • getHelpUrl

        public String getHelpUrl()
         Url for the help document for this data source.
        string help_url = 13;
        Specified by:
        getHelpUrl in interface DataSourceOrBuilder
        Returns:
        The helpUrl.

      • getHelpUrlBytes

        public com.google.protobuf.ByteString getHelpUrlBytes()
         Url for the help document for this data source.
        string help_url = 13;
        Specified by:
        getHelpUrlBytes in interface DataSourceOrBuilder
        Returns:
        The bytes for helpUrl.

      • getAuthorizationTypeValue

        public int getAuthorizationTypeValue()
         Indicates the type of authorization.
        .google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;
        Specified by:
        getAuthorizationTypeValue in interface DataSourceOrBuilder
        Returns:
        The enum numeric value on the wire for authorizationType.

      • getDataRefreshTypeValue

        public int getDataRefreshTypeValue()
         Specifies whether the data source supports automatic data refresh for the
 past few days, and how it's supported.
 For some data sources, data might not be complete until a few days later,
 so it's useful to refresh data automatically.
        .google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;
        Specified by:
        getDataRefreshTypeValue in interface DataSourceOrBuilder
        Returns:
        The enum numeric value on the wire for dataRefreshType.

      • getDataRefreshType

        public DataSource.DataRefreshType getDataRefreshType()
         Specifies whether the data source supports automatic data refresh for the
 past few days, and how it's supported.
 For some data sources, data might not be complete until a few days later,
 so it's useful to refresh data automatically.
        .google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;
        Specified by:
        getDataRefreshType in interface DataSourceOrBuilder
        Returns:
        The dataRefreshType.

      • getDefaultDataRefreshWindowDays

        public int getDefaultDataRefreshWindowDays()
         Default data refresh window on days.
 Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
        int32 default_data_refresh_window_days = 16;
        Specified by:
        getDefaultDataRefreshWindowDays in interface DataSourceOrBuilder
        Returns:
        The defaultDataRefreshWindowDays.

      • getManualRunsDisabled

        public boolean getManualRunsDisabled()
         Disables backfilling and manual run scheduling
 for the data source.
        bool manual_runs_disabled = 17;
        Specified by:
        getManualRunsDisabled in interface DataSourceOrBuilder
        Returns:
        The manualRunsDisabled.

      • hasMinimumScheduleInterval

        public boolean hasMinimumScheduleInterval()
         The minimum interval for scheduler to schedule runs.
        .google.protobuf.Duration minimum_schedule_interval = 18;
        Specified by:
        hasMinimumScheduleInterval in interface DataSourceOrBuilder
        Returns:
        Whether the minimumScheduleInterval field is set.

      • getMinimumScheduleInterval

        public com.google.protobuf.Duration getMinimumScheduleInterval()
         The minimum interval for scheduler to schedule runs.
        .google.protobuf.Duration minimum_schedule_interval = 18;
        Specified by:
        getMinimumScheduleInterval in interface DataSourceOrBuilder
        Returns:
        The minimumScheduleInterval.

      • getMinimumScheduleIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getMinimumScheduleIntervalOrBuilder()
         The minimum interval for scheduler to schedule runs.
        .google.protobuf.Duration minimum_schedule_interval = 18;
        Specified by:
        getMinimumScheduleIntervalOrBuilder in interface DataSourceOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static DataSource getDefaultInstance()

      • parser

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

      • getParserForType

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