com.google.cloud.bigquery.datatransfer.v1

Interface DataSourceOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

DataSource, DataSource.Builder

public interface DataSourceOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
DataSource.AuthorizationType	getAuthorizationType() Indicates the type of authorization.
int	getAuthorizationTypeValue() Indicates the type of authorization.
java.lang.String	getClientId() Data source client id which should be used to receive refresh token.
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.
java.lang.String	getDataSourceId() Data source id.
ByteString	getDataSourceIdBytes() Data source id.
int	getDefaultDataRefreshWindowDays() Default data refresh window on days.
java.lang.String	getDefaultSchedule() Default data transfer schedule.
ByteString	getDefaultScheduleBytes() Default data transfer schedule.
java.lang.String	getDescription() User friendly data source description string.
ByteString	getDescriptionBytes() User friendly data source description string.
java.lang.String	getDisplayName() User friendly data source name.
ByteString	getDisplayNameBytes() User friendly data source name.
java.lang.String	getHelpUrl() Url for the help document for this data source.
ByteString	getHelpUrlBytes() Url for the help document for this data source.
boolean	getManualRunsDisabled() Disables backfilling and manual run scheduling for the data source.
Duration	getMinimumScheduleInterval() The minimum interval for scheduler to schedule runs.
DurationOrBuilder	getMinimumScheduleIntervalOrBuilder() The minimum interval for scheduler to schedule runs.
java.lang.String	getName() Output only.
ByteString	getNameBytes() Output only.
DataSourceParameter	getParameters(int index) Data source parameters.
int	getParametersCount() Data source parameters.
java.util.List<DataSourceParameter>	getParametersList() Data source parameters.
DataSourceParameterOrBuilder	getParametersOrBuilder(int index) Data source parameters.
java.util.List<? extends DataSourceParameterOrBuilder>	getParametersOrBuilderList() Data source parameters.
java.lang.String	getScopes(int index) Api auth scopes for which refresh token needs to be obtained.
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.
java.util.List<java.lang.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() Indicates whether the data source supports multiple transfers to different BigQuery targets.
TransferType	getTransferType() Deprecated.
int	getTransferTypeValue() Deprecated.
int	getUpdateDeadlineSeconds() The number of seconds to wait for an update from the data source before BigQuery 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

java.lang.String getName()

 Output only. Data source resource name.
 

string name = 1;

getNameBytes

ByteString getNameBytes()

 Output only. Data source resource name.
 

string name = 1;

getDataSourceId

java.lang.String getDataSourceId()

 Data source id.
 

string data_source_id = 2;

getDataSourceIdBytes

ByteString getDataSourceIdBytes()

 Data source id.
 

string data_source_id = 2;

getDisplayName

java.lang.String getDisplayName()

 User friendly data source name.
 

string display_name = 3;

getDisplayNameBytes

ByteString getDisplayNameBytes()

 User friendly data source name.
 

string display_name = 3;

getDescription

java.lang.String getDescription()

 User friendly data source description string.
 

string description = 4;

getDescriptionBytes

ByteString getDescriptionBytes()

 User friendly data source description string.
 

string description = 4;

getClientId

java.lang.String getClientId()

 Data source client id which should be used to receive refresh token.
 When not supplied, no offline credentials are populated for data transfer.
 

string client_id = 5;

getClientIdBytes

ByteString getClientIdBytes()

 Data source client id which should be used to receive refresh token.
 When not supplied, no offline credentials are populated for data transfer.
 

string client_id = 5;

getScopesList

java.util.List<java.lang.String> getScopesList()

 Api auth scopes for which refresh token needs to be obtained. Only valid
 when `client_id` is specified. Ignored otherwise. 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;

getScopesCount

int getScopesCount()

 Api auth scopes for which refresh token needs to be obtained. Only valid
 when `client_id` is specified. Ignored otherwise. 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;

getScopes

java.lang.String getScopes(int index)

 Api auth scopes for which refresh token needs to be obtained. Only valid
 when `client_id` is specified. Ignored otherwise. 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;

getScopesBytes

ByteString getScopesBytes(int index)

 Api auth scopes for which refresh token needs to be obtained. Only valid
 when `client_id` is specified. Ignored otherwise. 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;

getTransferTypeValue

int getTransferTypeValue()

 Deprecated. This field has no effect.
 

.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7;

getTransferType

TransferType getTransferType()

 Deprecated. This field has no effect.
 

.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7;

getSupportsMultipleTransfers

boolean getSupportsMultipleTransfers()

 Indicates whether the data source supports multiple transfers
 to different BigQuery targets.
 

bool supports_multiple_transfers = 8;

getUpdateDeadlineSeconds

int getUpdateDeadlineSeconds()

 The number of seconds to wait for an update from the data source
 before BigQuery marks the transfer as failed.
 

int32 update_deadline_seconds = 9;

getDefaultSchedule

java.lang.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;

getDefaultScheduleBytes

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;

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;

getParametersList

java.util.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

java.util.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

java.lang.String getHelpUrl()

 Url for the help document for this data source.
 

string help_url = 13;

getHelpUrlBytes

ByteString getHelpUrlBytes()

 Url for the help document for this data source.
 

string help_url = 13;

getAuthorizationTypeValue

int getAuthorizationTypeValue()

 Indicates the type of authorization.
 

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

getAuthorizationType

DataSource.AuthorizationType getAuthorizationType()

 Indicates the type of authorization.
 

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

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;

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;

getDefaultDataRefreshWindowDays

int getDefaultDataRefreshWindowDays()

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

int32 default_data_refresh_window_days = 16;

getManualRunsDisabled

boolean getManualRunsDisabled()

 Disables backfilling and manual run scheduling
 for the data source.
 

bool manual_runs_disabled = 17;

hasMinimumScheduleInterval

boolean hasMinimumScheduleInterval()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;

getMinimumScheduleInterval

Duration getMinimumScheduleInterval()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;

getMinimumScheduleIntervalOrBuilder

DurationOrBuilder getMinimumScheduleIntervalOrBuilder()

 The minimum interval for scheduler to schedule runs.
 

.google.protobuf.Duration minimum_schedule_interval = 18;