com.google.cloud.bigquery.datatransfer.v1

Interface DataSourceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataSource, DataSource.Builder

public interface DataSourceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
DataSource.AuthorizationType	getAuthorizationType() Indicates the type of authorization.
int	getAuthorizationTypeValue() Indicates the type of authorization.
String	getClientId() Data source client id which should be used to receive refresh token.
com.google.protobuf.ByteString	getClientIdBytes() Data source client id which should be used to receive refresh token.
DataSource.DataRefreshType	getDataRefreshType() Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
int	getDataRefreshTypeValue() Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
String	getDataSourceId() Data source id.
com.google.protobuf.ByteString	getDataSourceIdBytes() Data source id.
int	getDefaultDataRefreshWindowDays() Default data refresh window on days.
String	getDefaultSchedule() Default data transfer schedule.
com.google.protobuf.ByteString	getDefaultScheduleBytes() Default data transfer schedule.
String	getDescription() User friendly data source description string.
com.google.protobuf.ByteString	getDescriptionBytes() User friendly data source description string.
String	getDisplayName() User friendly data source name.
com.google.protobuf.ByteString	getDisplayNameBytes() User friendly data source name.
String	getHelpUrl() Url for the help document for this data source.
com.google.protobuf.ByteString	getHelpUrlBytes() Url for the help document for this data source.
boolean	getManualRunsDisabled() Disables backfilling and manual run scheduling for the data source.
com.google.protobuf.Duration	getMinimumScheduleInterval() The minimum interval for scheduler to schedule runs.
com.google.protobuf.DurationOrBuilder	getMinimumScheduleIntervalOrBuilder() The minimum interval for scheduler to schedule runs.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
DataSourceParameter	getParameters(int index) Data source parameters.
int	getParametersCount() Data source parameters.
List<DataSourceParameter>	getParametersList() Data source parameters.
DataSourceParameterOrBuilder	getParametersOrBuilder(int index) Data source parameters.
List<? extends DataSourceParameterOrBuilder>	getParametersOrBuilderList() Data source parameters.
String	getScopes(int index) Api auth scopes for which refresh token needs to be obtained.
com.google.protobuf.ByteString	getScopesBytes(int index) Api auth scopes for which refresh token needs to be obtained.
int	getScopesCount() Api auth scopes for which refresh token needs to be obtained.
List<String>	getScopesList() Api auth scopes for which refresh token needs to be obtained.
boolean	getSupportsCustomSchedule() Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
boolean	getSupportsMultipleTransfers() Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
TransferType	getTransferType() Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380
int	getTransferTypeValue() Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380
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.
boolean	hasMinimumScheduleInterval() The minimum interval for scheduler to schedule runs.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Data source resource name.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Data source resource name.
 

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

Returns:

The bytes for name.

getDataSourceId

String getDataSourceId()

 Data source id.
 

string data_source_id = 2;

Returns:

The dataSourceId.

getDataSourceIdBytes

com.google.protobuf.ByteString getDataSourceIdBytes()

 Data source id.
 

string data_source_id = 2;

Returns:

The bytes for dataSourceId.

getDisplayName

String getDisplayName()

 User friendly data source name.
 

string display_name = 3;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 User friendly data source name.
 

string display_name = 3;

Returns:

The bytes for displayName.

getDescription

String getDescription()

 User friendly data source description string.
 

string description = 4;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 User friendly data source description string.
 

string description = 4;

Returns:

The bytes for description.

getClientId

String getClientId()

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

string client_id = 5;

Returns:

The clientId.

getClientIdBytes

com.google.protobuf.ByteString getClientIdBytes()

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

string client_id = 5;

Returns:

The bytes for clientId.

getScopesList

List<String> 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:

A list containing the scopes.

getScopesCount

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:

The count of scopes.

getScopes

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;

Parameters:

index - The index of the element to return.

Returns:

The scopes at the given index.

getScopesBytes

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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the scopes at the given index.

getTransferTypeValue

@Deprecated
int getTransferTypeValue()

Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380

 Deprecated. This field has no effect.
 

.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];

Returns:

The enum numeric value on the wire for transferType.

getTransferType

@Deprecated
TransferType getTransferType()

Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380

 Deprecated. This field has no effect.
 

.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];

Returns:

The transferType.

getSupportsMultipleTransfers

@Deprecated
boolean getSupportsMultipleTransfers()

Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383

 Deprecated. This field has no effect.
 

bool supports_multiple_transfers = 8 [deprecated = true];

Returns:

The supportsMultipleTransfers.

getUpdateDeadlineSeconds

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:

The updateDeadlineSeconds.

getDefaultSchedule

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:

The defaultSchedule.

getDefaultScheduleBytes

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;

Returns:

The bytes for defaultSchedule.

getSupportsCustomSchedule

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:

The supportsCustomSchedule.

getParametersList

List<DataSourceParameter> getParametersList()

 Data source parameters.
 

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

getParameters

DataSourceParameter getParameters(int index)

 Data source parameters.
 

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

getParametersCount

int getParametersCount()

 Data source parameters.
 

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

getParametersOrBuilderList

List<? extends DataSourceParameterOrBuilder> getParametersOrBuilderList()

 Data source parameters.
 

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

getParametersOrBuilder

DataSourceParameterOrBuilder getParametersOrBuilder(int index)

 Data source parameters.
 

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

getHelpUrl

String getHelpUrl()

 Url for the help document for this data source.
 

string help_url = 13;

Returns:

The helpUrl.

getHelpUrlBytes

com.google.protobuf.ByteString getHelpUrlBytes()

 Url for the help document for this data source.
 

string help_url = 13;

Returns:

The bytes for helpUrl.

getAuthorizationTypeValue

int getAuthorizationTypeValue()

 Indicates the type of authorization.
 

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

Returns:

The enum numeric value on the wire for authorizationType.

getAuthorizationType

DataSource.AuthorizationType getAuthorizationType()

 Indicates the type of authorization.
 

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

Returns:

The authorizationType.

getDataRefreshTypeValue

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:

The enum numeric value on the wire for dataRefreshType.

getDataRefreshType

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:

The dataRefreshType.

getDefaultDataRefreshWindowDays

int getDefaultDataRefreshWindowDays()

 Default data refresh window on days.
 Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
 

int32 default_data_refresh_window_days = 16;

Returns:

The defaultDataRefreshWindowDays.

getManualRunsDisabled

boolean getManualRunsDisabled()

 Disables backfilling and manual run scheduling
 for the data source.
 

bool manual_runs_disabled = 17;

Returns:

The manualRunsDisabled.

hasMinimumScheduleInterval

boolean hasMinimumScheduleInterval()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns:

Whether the minimumScheduleInterval field is set.

getMinimumScheduleInterval

com.google.protobuf.Duration getMinimumScheduleInterval()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns:

The minimumScheduleInterval.

getMinimumScheduleIntervalOrBuilder

com.google.protobuf.DurationOrBuilder getMinimumScheduleIntervalOrBuilder()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;