Interface DataSourceOrBuilder (2.36.0)

Version 2.36.0

• 2.51.0 (latest)
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.17
• 2.2.6
• 2.1.23
• 2.0.27

public interface DataSourceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthorizationType()

public abstract DataSource.AuthorizationType getAuthorizationType()

Indicates the type of authorization.

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

Returns
Type	Description
DataSource.AuthorizationType	The authorizationType.

getAuthorizationTypeValue()

public abstract int getAuthorizationTypeValue()

Indicates the type of authorization.

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

Returns
Type	Description
int	The enum numeric value on the wire for authorizationType.

getClientId()

public abstract String getClientId()

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

string client_id = 5;

Returns
Type	Description
String	The clientId.

getClientIdBytes()

public abstract ByteString getClientIdBytes()

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

string client_id = 5;

Returns
Type	Description
ByteString	The bytes for clientId.

getDataRefreshType()

public abstract 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
Type	Description
DataSource.DataRefreshType	The dataRefreshType.

getDataRefreshTypeValue()

public abstract 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
Type	Description
int	The enum numeric value on the wire for dataRefreshType.

getDataSourceId()

public abstract String getDataSourceId()

Data source id.

string data_source_id = 2;

Returns
Type	Description
String	The dataSourceId.

getDataSourceIdBytes()

public abstract ByteString getDataSourceIdBytes()

Data source id.

string data_source_id = 2;

Returns
Type	Description
ByteString	The bytes for dataSourceId.

getDefaultDataRefreshWindowDays()

public abstract int getDefaultDataRefreshWindowDays()

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

int32 default_data_refresh_window_days = 16;

Returns
Type	Description
int	The defaultDataRefreshWindowDays.

getDefaultSchedule()

public abstract 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
Type	Description
String	The defaultSchedule.

getDefaultScheduleBytes()

public abstract 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
Type	Description
ByteString	The bytes for defaultSchedule.

getDescription()

public abstract String getDescription()

User friendly data source description string.

string description = 4;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

User friendly data source description string.

string description = 4;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

User friendly data source name.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

User friendly data source name.

string display_name = 3;

Returns
Type	Description
ByteString	The bytes for displayName.

getHelpUrl()

public abstract String getHelpUrl()

Url for the help document for this data source.

string help_url = 13;

Returns
Type	Description
String	The helpUrl.

getHelpUrlBytes()

public abstract ByteString getHelpUrlBytes()

Url for the help document for this data source.

string help_url = 13;

Returns
Type	Description
ByteString	The bytes for helpUrl.

getManualRunsDisabled()

public abstract boolean getManualRunsDisabled()

Disables backfilling and manual run scheduling for the data source.

bool manual_runs_disabled = 17;

Returns
Type	Description
boolean	The manualRunsDisabled.

getMinimumScheduleInterval()

public abstract Duration getMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
Duration	The minimumScheduleInterval.

getMinimumScheduleIntervalOrBuilder()

public abstract DurationOrBuilder getMinimumScheduleIntervalOrBuilder()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
DurationOrBuilder

getName()

public abstract String getName()

Output only. Data source resource name.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Data source resource name.

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

Returns
Type	Description
ByteString	The bytes for name.

getParameters(int index)

public abstract DataSourceParameter getParameters(int index)

Data source parameters.

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

Parameter
Name	Description
index	int

Returns
Type	Description
DataSourceParameter

getParametersCount()

public abstract int getParametersCount()

Data source parameters.

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

Returns
Type	Description
int

getParametersList()

public abstract List<DataSourceParameter> getParametersList()

Data source parameters.

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

Returns
Type	Description
List<DataSourceParameter>

getParametersOrBuilder(int index)

public abstract DataSourceParameterOrBuilder getParametersOrBuilder(int index)

Data source parameters.

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

Parameter
Name	Description
index	int

Returns
Type	Description
DataSourceParameterOrBuilder

getParametersOrBuilderList()

public abstract List<? extends DataSourceParameterOrBuilder> getParametersOrBuilderList()

Data source parameters.

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

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

getScopes(int index)

public abstract 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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The scopes at the given index.

getScopesBytes(int index)

public abstract 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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the scopes at the given index.

getScopesCount()

public abstract 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
Type	Description
int	The count of scopes.

getScopesList()

public abstract 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
Type	Description
List<String>	A list containing the scopes.

getSupportsCustomSchedule()

public abstract 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
Type	Description
boolean	The supportsCustomSchedule.

getSupportsMultipleTransfers() (deprecated)

public abstract boolean getSupportsMultipleTransfers()

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

Deprecated. This field has no effect.

bool supports_multiple_transfers = 8 [deprecated = true];

Returns
Type	Description
boolean	The supportsMultipleTransfers.

getTransferType() (deprecated)

public abstract TransferType getTransferType()

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

Deprecated. This field has no effect.

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

Returns
Type	Description
TransferType	The transferType.

getTransferTypeValue() (deprecated)

public abstract int getTransferTypeValue()

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

Deprecated. This field has no effect.

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

Returns
Type	Description
int	The enum numeric value on the wire for transferType.

getUpdateDeadlineSeconds()

public abstract 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
Type	Description
int	The updateDeadlineSeconds.

hasMinimumScheduleInterval()

public abstract boolean hasMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
boolean	Whether the minimumScheduleInterval field is set.