Class DataSource.Builder (2.34.0)

public static final class DataSource.Builder extends GeneratedMessageV3.Builder<DataSource.Builder> implements DataSourceOrBuilder

Defines the properties and custom parameters for a data source.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataSource.Builder

Implements

DataSourceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllParameters(Iterable<? extends DataSourceParameter> values)

public DataSource.Builder addAllParameters(Iterable<? extends DataSourceParameter> values)

Data source parameters.

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter>`

Returns
Type	Description
`DataSource.Builder`

addAllScopes(Iterable<String> values)

public DataSource.Builder addAllScopes(Iterable<String> values)

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
`values`	`Iterable<String>` The scopes to add.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

addParameters(DataSourceParameter value)

public DataSource.Builder addParameters(DataSourceParameter value)

Data source parameters.

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

Parameter
Name	Description
`value`	`DataSourceParameter`

Returns
Type	Description
`DataSource.Builder`

addParameters(DataSourceParameter.Builder builderForValue)

public DataSource.Builder addParameters(DataSourceParameter.Builder builderForValue)

Data source parameters.

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

Parameter
Name	Description
`builderForValue`	`DataSourceParameter.Builder`

Returns
Type	Description
`DataSource.Builder`

addParameters(int index, DataSourceParameter value)

public DataSource.Builder addParameters(int index, DataSourceParameter value)

Data source parameters.

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

Parameters
Name	Description
`index`	`int`
`value`	`DataSourceParameter`

Returns
Type	Description
`DataSource.Builder`

addParameters(int index, DataSourceParameter.Builder builderForValue)

public DataSource.Builder addParameters(int index, DataSourceParameter.Builder builderForValue)

Data source parameters.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DataSourceParameter.Builder`

Returns
Type	Description
`DataSource.Builder`

addParametersBuilder()

public DataSourceParameter.Builder addParametersBuilder()

Data source parameters.

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

Returns
Type	Description
`DataSourceParameter.Builder`

addParametersBuilder(int index)

public DataSourceParameter.Builder addParametersBuilder(int index)

Data source parameters.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DataSourceParameter.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataSource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addScopes(String value)

public DataSource.Builder addScopes(String value)

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
`value`	`String` The scopes to add.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

addScopesBytes(ByteString value)

public DataSource.Builder addScopesBytes(ByteString value)

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
`value`	`ByteString` The bytes of the scopes to add.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

build()

public DataSource build()

Returns
Type	Description
`DataSource`

buildPartial()

public DataSource buildPartial()

Returns
Type	Description
`DataSource`

clear()

public DataSource.Builder clear()

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAuthorizationType()

public DataSource.Builder clearAuthorizationType()

Indicates the type of authorization.

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

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearClientId()

public DataSource.Builder clearClientId()

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

string client_id = 5;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearDataRefreshType()

public DataSource.Builder clearDataRefreshType()

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.Builder`	This builder for chaining.

clearDataSourceId()

public DataSource.Builder clearDataSourceId()

Data source id.

string data_source_id = 2;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearDefaultDataRefreshWindowDays()

public DataSource.Builder clearDefaultDataRefreshWindowDays()

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

int32 default_data_refresh_window_days = 16;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearDefaultSchedule()

public DataSource.Builder clearDefaultSchedule()

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
`DataSource.Builder`	This builder for chaining.

clearDescription()

public DataSource.Builder clearDescription()

User friendly data source description string.

string description = 4;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearDisplayName()

public DataSource.Builder clearDisplayName()

User friendly data source name.

string display_name = 3;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataSource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHelpUrl()

public DataSource.Builder clearHelpUrl()

Url for the help document for this data source.

string help_url = 13;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearManualRunsDisabled()

public DataSource.Builder clearManualRunsDisabled()

Disables backfilling and manual run scheduling for the data source.

bool manual_runs_disabled = 17;

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearMinimumScheduleInterval()

public DataSource.Builder clearMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
`DataSource.Builder`

clearName()

public DataSource.Builder clearName()

Output only. Data source resource name.

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

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParameters()

public DataSource.Builder clearParameters()

Data source parameters.

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

Returns
Type	Description
`DataSource.Builder`

clearScopes()

public DataSource.Builder clearScopes()

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
`DataSource.Builder`	This builder for chaining.

clearSupportsCustomSchedule()

public DataSource.Builder clearSupportsCustomSchedule()

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
`DataSource.Builder`	This builder for chaining.

clearSupportsMultipleTransfers() (deprecated)

public DataSource.Builder clearSupportsMultipleTransfers()

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
Type	Description
`DataSource.Builder`	This builder for chaining.

clearTransferType() (deprecated)

public DataSource.Builder clearTransferType()

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
Type	Description
`DataSource.Builder`	This builder for chaining.

clearUpdateDeadlineSeconds()

public DataSource.Builder clearUpdateDeadlineSeconds()

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
`DataSource.Builder`	This builder for chaining.

clone()

public DataSource.Builder clone()

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAuthorizationType()

public 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 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 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 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 DataSource.DataRefreshType getDataRefreshType()

.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;

Returns
Type	Description
`DataSource.DataRefreshType`	The dataRefreshType.

getDataRefreshTypeValue()

public int getDataRefreshTypeValue()

.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 String getDataSourceId()

Data source id.

string data_source_id = 2;

Returns
Type	Description
`String`	The dataSourceId.

getDataSourceIdBytes()

public ByteString getDataSourceIdBytes()

Data source id.

string data_source_id = 2;

Returns
Type	Description
`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
Type	Description
`int`	The defaultDataRefreshWindowDays.

getDefaultInstanceForType()

public DataSource getDefaultInstanceForType()

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

getDescription()

public String getDescription()

User friendly data source description string.

string description = 4;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User friendly data source description string.

string description = 4;

Returns
Type	Description
`ByteString`	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

User friendly data source name.

string display_name = 3;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User friendly data source name.

string display_name = 3;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getHelpUrl()

public String getHelpUrl()

Url for the help document for this data source.

string help_url = 13;

Returns
Type	Description
`String`	The helpUrl.

getHelpUrlBytes()

public 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 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 Duration getMinimumScheduleInterval()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
`Duration`	The minimumScheduleInterval.

getMinimumScheduleIntervalBuilder()

public Duration.Builder getMinimumScheduleIntervalBuilder()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
`Builder`

getMinimumScheduleIntervalOrBuilder()

public DurationOrBuilder getMinimumScheduleIntervalOrBuilder()

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Returns
Type	Description
`DurationOrBuilder`

getName()

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

getParametersBuilder(int index)

public DataSourceParameter.Builder getParametersBuilder(int index)

Data source parameters.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DataSourceParameter.Builder`

getParametersBuilderList()

public List<DataSourceParameter.Builder> getParametersBuilderList()

Data source parameters.

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

Returns
Type	Description
`List<Builder>`

getParametersCount()

public int getParametersCount()

Data source parameters.

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

Returns
Type	Description
`int`

getParametersList()

public List<DataSourceParameter> getParametersList()

Data source parameters.

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

Returns
Type	Description
`List<DataSourceParameter>`

getParametersOrBuilder(int index)

public 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 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 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 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 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 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
Type	Description
`ProtocolStringList`	A list containing the scopes.

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

hasMinimumScheduleInterval()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DataSource other)

public DataSource.Builder mergeFrom(DataSource other)

Parameter
Name	Description
`other`	`DataSource`

Returns
Type	Description
`DataSource.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataSource.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DataSource.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DataSource.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMinimumScheduleInterval(Duration value)

public DataSource.Builder mergeMinimumScheduleInterval(Duration value)

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`DataSource.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeParameters(int index)

public DataSource.Builder removeParameters(int index)

Data source parameters.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DataSource.Builder`

setAuthorizationType(DataSource.AuthorizationType value)

public DataSource.Builder setAuthorizationType(DataSource.AuthorizationType value)

Indicates the type of authorization.

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

Parameter
Name	Description
`value`	`DataSource.AuthorizationType` The authorizationType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setAuthorizationTypeValue(int value)

public DataSource.Builder setAuthorizationTypeValue(int value)

Indicates the type of authorization.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for authorizationType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setClientId(String value)

public DataSource.Builder setClientId(String value)

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

string client_id = 5;

Parameter
Name	Description
`value`	`String` The clientId to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setClientIdBytes(ByteString value)

public DataSource.Builder setClientIdBytes(ByteString value)

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

string client_id = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for clientId to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDataRefreshType(DataSource.DataRefreshType value)

public DataSource.Builder setDataRefreshType(DataSource.DataRefreshType value)

.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;

Parameter
Name	Description
`value`	`DataSource.DataRefreshType` The dataRefreshType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDataRefreshTypeValue(int value)

public DataSource.Builder setDataRefreshTypeValue(int value)

.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataRefreshType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDataSourceId(String value)

public DataSource.Builder setDataSourceId(String value)

Data source id.

string data_source_id = 2;

Parameter
Name	Description
`value`	`String` The dataSourceId to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDataSourceIdBytes(ByteString value)

public DataSource.Builder setDataSourceIdBytes(ByteString value)

Data source id.

string data_source_id = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for dataSourceId to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDefaultDataRefreshWindowDays(int value)

public DataSource.Builder setDefaultDataRefreshWindowDays(int value)

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

int32 default_data_refresh_window_days = 16;

Parameter
Name	Description
`value`	`int` The defaultDataRefreshWindowDays to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDefaultSchedule(String value)

public DataSource.Builder setDefaultSchedule(String value)

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;

Parameter
Name	Description
`value`	`String` The defaultSchedule to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDefaultScheduleBytes(ByteString value)

public DataSource.Builder setDefaultScheduleBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for defaultSchedule to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDescription(String value)

public DataSource.Builder setDescription(String value)

User friendly data source description string.

string description = 4;

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public DataSource.Builder setDescriptionBytes(ByteString value)

User friendly data source description string.

string description = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDisplayName(String value)

public DataSource.Builder setDisplayName(String value)

User friendly data source name.

string display_name = 3;

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataSource.Builder setDisplayNameBytes(ByteString value)

User friendly data source name.

string display_name = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataSource.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHelpUrl(String value)

public DataSource.Builder setHelpUrl(String value)

Url for the help document for this data source.

string help_url = 13;

Parameter
Name	Description
`value`	`String` The helpUrl to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setHelpUrlBytes(ByteString value)

public DataSource.Builder setHelpUrlBytes(ByteString value)

Url for the help document for this data source.

string help_url = 13;

Parameter
Name	Description
`value`	`ByteString` The bytes for helpUrl to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setManualRunsDisabled(boolean value)

public DataSource.Builder setManualRunsDisabled(boolean value)

Disables backfilling and manual run scheduling for the data source.

bool manual_runs_disabled = 17;

Parameter
Name	Description
`value`	`boolean` The manualRunsDisabled to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setMinimumScheduleInterval(Duration value)

public DataSource.Builder setMinimumScheduleInterval(Duration value)

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`DataSource.Builder`

setMinimumScheduleInterval(Duration.Builder builderForValue)

public DataSource.Builder setMinimumScheduleInterval(Duration.Builder builderForValue)

The minimum interval for scheduler to schedule runs.

.google.protobuf.Duration minimum_schedule_interval = 18;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DataSource.Builder`

setName(String value)

public DataSource.Builder setName(String value)

Output only. Data source resource name.

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public DataSource.Builder setNameBytes(ByteString value)

Output only. Data source resource name.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setParameters(int index, DataSourceParameter value)

public DataSource.Builder setParameters(int index, DataSourceParameter value)

Data source parameters.

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

Parameters
Name	Description
`index`	`int`
`value`	`DataSourceParameter`

Returns
Type	Description
`DataSource.Builder`

setParameters(int index, DataSourceParameter.Builder builderForValue)

public DataSource.Builder setParameters(int index, DataSourceParameter.Builder builderForValue)

Data source parameters.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DataSourceParameter.Builder`

Returns
Type	Description
`DataSource.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataSource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScopes(int index, String value)

public DataSource.Builder setScopes(int index, String value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The scopes to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setSupportsCustomSchedule(boolean value)

public DataSource.Builder setSupportsCustomSchedule(boolean value)

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;

Parameter
Name	Description
`value`	`boolean` The supportsCustomSchedule to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setSupportsMultipleTransfers(boolean value) (deprecated)

public DataSource.Builder setSupportsMultipleTransfers(boolean value)

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

Parameter
Name	Description
`value`	`boolean` The supportsMultipleTransfers to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setTransferType(TransferType value) (deprecated)

public DataSource.Builder setTransferType(TransferType value)

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

Parameter
Name	Description
`value`	`TransferType` The transferType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setTransferTypeValue(int value) (deprecated)

public DataSource.Builder setTransferTypeValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for transferType to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DataSource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateDeadlineSeconds(int value)

public DataSource.Builder setUpdateDeadlineSeconds(int value)

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;

Parameter
Name	Description
`value`	`int` The updateDeadlineSeconds to set.

Returns
Type	Description
`DataSource.Builder`	This builder for chaining.