BigQuery Data Transfer V1 Client - Class DataSourceDefinition (1.4.5)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class DataSourceDefinition.

Represents the data source definition.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.DataSourceDefinition

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ data_source Google\Cloud\BigQuery\DataTransfer\V1\DataSource

Data source metadata.

↳ transfer_run_pubsub_topic string

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.

↳ run_time_offset Google\Protobuf\Duration

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.

↳ support_email string

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

↳ service_account string

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.

↳ disabled bool

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.

↳ transfer_config_pubsub_topic string

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.

↳ supported_location_ids string[]

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;

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

Returns
TypeDescription
string

setName

The resource name of the data source definition.

Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataSource

Data source metadata.

Returns
TypeDescription
Google\Cloud\BigQuery\DataTransfer\V1\DataSource

setDataSource

Data source metadata.

Parameter
NameDescription
var Google\Cloud\BigQuery\DataTransfer\V1\DataSource
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setTransferRunPubsubTopic

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
Google\Protobuf\Duration

setRunTimeOffset

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.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getSupportEmail

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

Returns
TypeDescription
string

setSupportEmail

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setServiceAccount

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
bool

setDisabled

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setTransferConfigPubsubTopic

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSupportedLocationIds

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;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSupportedLocationIds

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;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this