Class DataSource (2.35.0)

public final class DataSource extends GeneratedMessageV3 implements DataSourceOrBuilder

Defines the properties and custom parameters for a data source.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSource

Implements

DataSourceOrBuilder

Static Fields

AUTHORIZATION_TYPE_FIELD_NUMBER

public static final int AUTHORIZATION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

CLIENT_ID_FIELD_NUMBER

public static final int CLIENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_REFRESH_TYPE_FIELD_NUMBER

public static final int DATA_REFRESH_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_SOURCE_ID_FIELD_NUMBER

public static final int DATA_SOURCE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER

public static final int DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_SCHEDULE_FIELD_NUMBER

public static final int DEFAULT_SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

HELP_URL_FIELD_NUMBER

public static final int HELP_URL_FIELD_NUMBER
Field Value
TypeDescription
int

MANUAL_RUNS_DISABLED_FIELD_NUMBER

public static final int MANUAL_RUNS_DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER

public static final int MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

SCOPES_FIELD_NUMBER

public static final int SCOPES_FIELD_NUMBER
Field Value
TypeDescription
int

SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER

public static final int SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER

public static final int SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSFER_TYPE_FIELD_NUMBER

public static final int TRANSFER_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_DEADLINE_SECONDS_FIELD_NUMBER

public static final int UPDATE_DEADLINE_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataSource getDefaultInstance()
Returns
TypeDescription
DataSource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DataSource.Builder newBuilder()
Returns
TypeDescription
DataSource.Builder

newBuilder(DataSource prototype)

public static DataSource.Builder newBuilder(DataSource prototype)
Parameter
NameDescription
prototypeDataSource
Returns
TypeDescription
DataSource.Builder

parseDelimitedFrom(InputStream input)

public static DataSource parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DataSource parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataSource parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataSource parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DataSource parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DataSource parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DataSource> parser()
Returns
TypeDescription
Parser<DataSource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAuthorizationType()

public DataSource.AuthorizationType getAuthorizationType()

Indicates the type of authorization.

.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;

Returns
TypeDescription
DataSource.AuthorizationType

The authorizationType.

getAuthorizationTypeValue()

public int getAuthorizationTypeValue()

Indicates the type of authorization.

.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;

Returns
TypeDescription
int

The enum numeric value on the wire for authorizationType.

getClientId()

public String getClientId()

Data source client id which should be used to receive refresh token.

string client_id = 5;

Returns
TypeDescription
String

The clientId.

getClientIdBytes()

public ByteString getClientIdBytes()

Data source client id which should be used to receive refresh token.

string client_id = 5;

Returns
TypeDescription
ByteString

The bytes for clientId.

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;

Returns
TypeDescription
DataSource.DataRefreshType

The dataRefreshType.

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;

Returns
TypeDescription
int

The enum numeric value on the wire for dataRefreshType.

getDataSourceId()

public String getDataSourceId()

Data source id.

string data_source_id = 2;

Returns
TypeDescription
String

The dataSourceId.

getDataSourceIdBytes()

public ByteString getDataSourceIdBytes()

Data source id.

string data_source_id = 2;

Returns
TypeDescription
ByteString

The bytes for dataSourceId.

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;

Returns
TypeDescription
int

The defaultDataRefreshWindowDays.

getDefaultInstanceForType()

public DataSource getDefaultInstanceForType()
Returns
TypeDescription
DataSource

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;

Returns
TypeDescription
String

The defaultSchedule.

getDefaultScheduleBytes()

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

Returns
TypeDescription
ByteString

The bytes for defaultSchedule.

getDescription()

public String getDescription()

User friendly data source description string.

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User friendly data source description string.

string description = 4;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

User friendly data source name.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User friendly data source name.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getHelpUrl()

public String getHelpUrl()

Url for the help document for this data source.

string help_url = 13;

Returns
TypeDescription
String

The helpUrl.

getHelpUrlBytes()

public ByteString getHelpUrlBytes()

Url for the help document for this data source.

string help_url = 13;

Returns
TypeDescription
ByteString

The bytes for helpUrl.

getManualRunsDisabled()

public boolean getManualRunsDisabled()

Disables backfilling and manual run scheduling for the data source.

bool manual_runs_disabled = 17;

Returns
TypeDescription
boolean

The manualRunsDisabled.

getMinimumScheduleInterval()

public Duration getMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
TypeDescription
Duration

The minimumScheduleInterval.

getMinimumScheduleIntervalOrBuilder()

public DurationOrBuilder getMinimumScheduleIntervalOrBuilder()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
TypeDescription
DurationOrBuilder

getName()

public String getName()

Output only. Data source resource name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Data source resource name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParameters(int index)

public DataSourceParameter getParameters(int index)

Data source parameters.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameter

getParametersCount()

public int getParametersCount()

Data source parameters.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;

Returns
TypeDescription
int

getParametersList()

public List<DataSourceParameter> getParametersList()

Data source parameters.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;

Returns
TypeDescription
List<DataSourceParameter>

getParametersOrBuilder(int index)

public DataSourceParameterOrBuilder getParametersOrBuilder(int index)

Data source parameters.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameterOrBuilder

getParametersOrBuilderList()

public List<? extends DataSourceParameterOrBuilder> getParametersOrBuilderList()

Data source parameters.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;

Returns
TypeDescription
List<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameterOrBuilder>

getParserForType()

public Parser<DataSource> getParserForType()
Returns
TypeDescription
Parser<DataSource>
Overrides

getScopes(int index)

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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The scopes at the given index.

getScopesBytes(int index)

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the scopes at the given index.

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;

Returns
TypeDescription
int

The count of scopes.

getScopesList()

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

Returns
TypeDescription
ProtocolStringList

A list containing the scopes.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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;

Returns
TypeDescription
boolean

The supportsCustomSchedule.

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

Returns
TypeDescription
boolean

The supportsMultipleTransfers.

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

Returns
TypeDescription
TransferType

The transferType.

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

Returns
TypeDescription
int

The enum numeric value on the wire for transferType.

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;

Returns
TypeDescription
int

The updateDeadlineSeconds.

hasMinimumScheduleInterval()

public boolean hasMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
TypeDescription
boolean

Whether the minimumScheduleInterval field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DataSource.Builder newBuilderForType()
Returns
TypeDescription
DataSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DataSource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DataSource.Builder toBuilder()
Returns
TypeDescription
DataSource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException