Class DataSourceDefinition.Builder (2.3.17)

Version 2.3.17

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 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 static final class DataSourceDefinition.Builder extends GeneratedMessageV3.Builder<DataSourceDefinition.Builder> implements DataSourceDefinitionOrBuilder

Represents the data source definition.

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

Inheritance

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

Implements

DataSourceDefinitionOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addAllSupportedLocationIds(Iterable<String> values)

public DataSourceDefinition.Builder addAllSupportedLocationIds(Iterable<String> values)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameter

Name	Description
values	Iterable<String>

Returns

Type	Description
DataSourceDefinition.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

addSupportedLocationIds(String value)

public DataSourceDefinition.Builder addSupportedLocationIds(String value)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

addSupportedLocationIdsBytes(ByteString value)

public DataSourceDefinition.Builder addSupportedLocationIdsBytes(ByteString value)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

build()

public DataSourceDefinition build()

Returns

Type	Description
DataSourceDefinition

buildPartial()

public DataSourceDefinition buildPartial()

Returns

Type	Description
DataSourceDefinition

clear()

public DataSourceDefinition.Builder clear()

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDataSource()

public DataSourceDefinition.Builder clearDataSource()

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Returns

Type	Description
DataSourceDefinition.Builder

clearDisabled()

public DataSourceDefinition.Builder clearDisabled()

Is data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.

bool disabled = 5;

Returns

Type	Description
DataSourceDefinition.Builder

clearField(Descriptors.FieldDescriptor field)

public DataSourceDefinition.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

clearName()

public DataSourceDefinition.Builder clearName()

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

string name = 21;

Returns

Type	Description
DataSourceDefinition.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DataSourceDefinition.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

clearRunTimeOffset()

public DataSourceDefinition.Builder clearRunTimeOffset()

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Returns

Type	Description
DataSourceDefinition.Builder

clearServiceAccount()

public DataSourceDefinition.Builder clearServiceAccount()

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

string service_account = 2;

Returns

Type	Description
DataSourceDefinition.Builder

clearSupportEmail()

public DataSourceDefinition.Builder clearSupportEmail()

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

string support_email = 22;

Returns

Type	Description
DataSourceDefinition.Builder

clearSupportedLocationIds()

public DataSourceDefinition.Builder clearSupportedLocationIds()

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Returns

Type	Description
DataSourceDefinition.Builder

clearTransferConfigPubsubTopic()

public DataSourceDefinition.Builder clearTransferConfigPubsubTopic()

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

string transfer_config_pubsub_topic = 12;

Returns

Type	Description
DataSourceDefinition.Builder

clearTransferRunPubsubTopic()

public DataSourceDefinition.Builder clearTransferRunPubsubTopic()

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

string transfer_run_pubsub_topic = 13;

Returns

Type	Description
DataSourceDefinition.Builder

clone()

public DataSourceDefinition.Builder clone()

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDataSource()

public DataSource getDataSource()

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Returns

Type	Description
DataSource

getDataSourceBuilder()

public DataSource.Builder getDataSourceBuilder()

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Returns

Type	Description
DataSource.Builder

getDataSourceOrBuilder()

public DataSourceOrBuilder getDataSourceOrBuilder()

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Returns

Type	Description
DataSourceOrBuilder

getDefaultInstanceForType()

public DataSourceDefinition getDefaultInstanceForType()

Returns

Type	Description
DataSourceDefinition

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisabled()

public boolean getDisabled()

Is data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.

bool disabled = 5;

Returns

Type	Description
boolean

getName()

public String getName()

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

string name = 21;

Returns

Type	Description
String

getNameBytes()

public ByteString getNameBytes()

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

string name = 21;

Returns

Type	Description
ByteString

getRunTimeOffset()

public Duration getRunTimeOffset()

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Returns

Type	Description
Duration

getRunTimeOffsetBuilder()

public Duration.Builder getRunTimeOffsetBuilder()

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Returns

Type	Description
Builder

getRunTimeOffsetOrBuilder()

public DurationOrBuilder getRunTimeOffsetOrBuilder()

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Returns

Type	Description
DurationOrBuilder

getServiceAccount()

public String getServiceAccount()

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

string service_account = 2;

Returns

Type	Description
String

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

string service_account = 2;

Returns

Type	Description
ByteString

getSupportEmail()

public String getSupportEmail()

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

string support_email = 22;

Returns

Type	Description
String

getSupportEmailBytes()

public ByteString getSupportEmailBytes()

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

string support_email = 22;

Returns

Type	Description
ByteString

getSupportedLocationIds(int index)

public String getSupportedLocationIds(int index)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameter

Name	Description
index	int

Returns

Type	Description
String

getSupportedLocationIdsBytes(int index)

public ByteString getSupportedLocationIdsBytes(int index)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameter

Name	Description
index	int

Returns

Type	Description
ByteString

getSupportedLocationIdsCount()

public int getSupportedLocationIdsCount()

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Returns

Type	Description
int

getSupportedLocationIdsList()

public ProtocolStringList getSupportedLocationIdsList()

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Returns

Type	Description
ProtocolStringList

getTransferConfigPubsubTopic()

public String getTransferConfigPubsubTopic()

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

string transfer_config_pubsub_topic = 12;

Returns

Type	Description
String

getTransferConfigPubsubTopicBytes()

public ByteString getTransferConfigPubsubTopicBytes()

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

string transfer_config_pubsub_topic = 12;

Returns

Type	Description
ByteString

getTransferRunPubsubTopic()

public String getTransferRunPubsubTopic()

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

string transfer_run_pubsub_topic = 13;

Returns

Type	Description
String

getTransferRunPubsubTopicBytes()

public ByteString getTransferRunPubsubTopicBytes()

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

string transfer_run_pubsub_topic = 13;

Returns

Type	Description
ByteString

hasDataSource()

public boolean hasDataSource()

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Returns

Type	Description
boolean

hasRunTimeOffset()

public boolean hasRunTimeOffset()

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Returns

Type	Description
boolean

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()

mergeDataSource(DataSource value)

public DataSourceDefinition.Builder mergeDataSource(DataSource value)

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Parameter

Name	Description
value	DataSource

Returns

Type	Description
DataSourceDefinition.Builder

mergeFrom(DataSourceDefinition other)

public DataSourceDefinition.Builder mergeFrom(DataSourceDefinition other)

Parameter

Name	Description
other	DataSourceDefinition

Returns

Type	Description
DataSourceDefinition.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public DataSourceDefinition.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

mergeRunTimeOffset(Duration value)

public DataSourceDefinition.Builder mergeRunTimeOffset(Duration value)

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Parameter

Name	Description
value	Duration

Returns

Type	Description
DataSourceDefinition.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataSourceDefinition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

setDataSource(DataSource value)

public DataSourceDefinition.Builder setDataSource(DataSource value)

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Parameter

Name	Description
value	DataSource

Returns

Type	Description
DataSourceDefinition.Builder

setDataSource(DataSource.Builder builderForValue)

public DataSourceDefinition.Builder setDataSource(DataSource.Builder builderForValue)

Data source metadata.

.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;

Parameter

Name	Description
builderForValue	DataSource.Builder

Returns

Type	Description
DataSourceDefinition.Builder

setDisabled(boolean value)

public DataSourceDefinition.Builder setDisabled(boolean value)

Is data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.

bool disabled = 5;

Parameter

Name	Description
value	boolean

Returns

Type	Description
DataSourceDefinition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

setName(String value)

public DataSourceDefinition.Builder setName(String value)

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

string name = 21;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setNameBytes(ByteString value)

public DataSourceDefinition.Builder setNameBytes(ByteString value)

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

string name = 21;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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

setRunTimeOffset(Duration value)

public DataSourceDefinition.Builder setRunTimeOffset(Duration value)

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Parameter

Name	Description
value	Duration

Returns

Type	Description
DataSourceDefinition.Builder

setRunTimeOffset(Duration.Builder builderForValue)

public DataSourceDefinition.Builder setRunTimeOffset(Duration.Builder builderForValue)

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

.google.protobuf.Duration run_time_offset = 16;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
DataSourceDefinition.Builder

setServiceAccount(String value)

public DataSourceDefinition.Builder setServiceAccount(String value)

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

string service_account = 2;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setServiceAccountBytes(ByteString value)

public DataSourceDefinition.Builder setServiceAccountBytes(ByteString value)

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

string service_account = 2;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

setSupportEmail(String value)

public DataSourceDefinition.Builder setSupportEmail(String value)

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

string support_email = 22;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setSupportEmailBytes(ByteString value)

public DataSourceDefinition.Builder setSupportEmailBytes(ByteString value)

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

string support_email = 22;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

setSupportedLocationIds(int index, String value)

public DataSourceDefinition.Builder setSupportedLocationIds(int index, String value)

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

repeated string supported_location_ids = 23;

Parameters

Name	Description
index	int
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setTransferConfigPubsubTopic(String value)

public DataSourceDefinition.Builder setTransferConfigPubsubTopic(String value)

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

string transfer_config_pubsub_topic = 12;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setTransferConfigPubsubTopicBytes(ByteString value)

public DataSourceDefinition.Builder setTransferConfigPubsubTopicBytes(ByteString value)

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

string transfer_config_pubsub_topic = 12;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

setTransferRunPubsubTopic(String value)

public DataSourceDefinition.Builder setTransferRunPubsubTopic(String value)

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

string transfer_run_pubsub_topic = 13;

Parameter

Name	Description
value	String

Returns

Type	Description
DataSourceDefinition.Builder

setTransferRunPubsubTopicBytes(ByteString value)

public DataSourceDefinition.Builder setTransferRunPubsubTopicBytes(ByteString value)

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

string transfer_run_pubsub_topic = 13;

Parameter

Name	Description
value	ByteString

Returns

Type	Description
DataSourceDefinition.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DataSourceDefinition.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
DataSourceDefinition.Builder

Overrides

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