google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient Class Reference

This API allows users to manage their data transfers into BigQuery. More...

#include <google/cloud/bigquery/datatransfer/v1/data_transfer_client.h>

Public Member Functions
	DataTransferServiceClient (std::shared_ptr< DataTransferServiceConnection > connection, Options opts={})
	~DataTransferServiceClient ()
StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource >	GetDataSource (std::string const &name, Options opts={})
	Retrieves a supported data source and returns its settings. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource >	GetDataSource (google::cloud::bigquery::datatransfer::v1::GetDataSourceRequest const &request, Options opts={})
	Retrieves a supported data source and returns its settings. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource >	ListDataSources (std::string const &parent, Options opts={})
	Lists supported data sources and returns their settings. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource >	ListDataSources (google::cloud::bigquery::datatransfer::v1::ListDataSourcesRequest request, Options opts={})
	Lists supported data sources and returns their settings. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	CreateTransferConfig (std::string const &parent, google::cloud::bigquery::datatransfer::v1::TransferConfig const &transfer_config, Options opts={})
	Creates a new data transfer configuration. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	CreateTransferConfig (google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest const &request, Options opts={})
	Creates a new data transfer configuration. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	UpdateTransferConfig (google::cloud::bigquery::datatransfer::v1::TransferConfig const &transfer_config, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates a data transfer configuration. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	UpdateTransferConfig (google::cloud::bigquery::datatransfer::v1::UpdateTransferConfigRequest const &request, Options opts={})
	Updates a data transfer configuration. More...
Status	DeleteTransferConfig (std::string const &name, Options opts={})
	Deletes a data transfer configuration, including any associated transfer runs and logs. More...
Status	DeleteTransferConfig (google::cloud::bigquery::datatransfer::v1::DeleteTransferConfigRequest const &request, Options opts={})
	Deletes a data transfer configuration, including any associated transfer runs and logs. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	GetTransferConfig (std::string const &name, Options opts={})
	Returns information about a data transfer config. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	GetTransferConfig (google::cloud::bigquery::datatransfer::v1::GetTransferConfigRequest const &request, Options opts={})
	Returns information about a data transfer config. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig >	ListTransferConfigs (std::string const &parent, Options opts={})
	Returns information about all transfer configs owned by a project in the specified location. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig >	ListTransferConfigs (google::cloud::bigquery::datatransfer::v1::ListTransferConfigsRequest request, Options opts={})
	Returns information about all transfer configs owned by a project in the specified location. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse >	ScheduleTransferRuns (std::string const &parent, google::protobuf::Timestamp const &start_time, google::protobuf::Timestamp const &end_time, Options opts={})
	Creates transfer runs for a time range [start_time, end_time]. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse >	ScheduleTransferRuns (google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsRequest const &request, Options opts={})
	Creates transfer runs for a time range [start_time, end_time]. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsResponse >	StartManualTransferRuns (google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsRequest const &request, Options opts={})
	Start manual transfer runs to be executed now with schedule_time equal to current time. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun >	GetTransferRun (std::string const &name, Options opts={})
	Returns information about the particular transfer run. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun >	GetTransferRun (google::cloud::bigquery::datatransfer::v1::GetTransferRunRequest const &request, Options opts={})
	Returns information about the particular transfer run. More...
Status	DeleteTransferRun (std::string const &name, Options opts={})
	Deletes the specified transfer run. More...
Status	DeleteTransferRun (google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest const &request, Options opts={})
	Deletes the specified transfer run. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun >	ListTransferRuns (std::string const &parent, Options opts={})
	Returns information about running and completed transfer runs. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun >	ListTransferRuns (google::cloud::bigquery::datatransfer::v1::ListTransferRunsRequest request, Options opts={})
	Returns information about running and completed transfer runs. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage >	ListTransferLogs (std::string const &parent, Options opts={})
	Returns log messages for the transfer run. More...
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage >	ListTransferLogs (google::cloud::bigquery::datatransfer::v1::ListTransferLogsRequest request, Options opts={})
	Returns log messages for the transfer run. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse >	CheckValidCreds (std::string const &name, Options opts={})
	Returns true if valid credentials exist for the given data source and requesting user. More...
StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse >	CheckValidCreds (google::cloud::bigquery::datatransfer::v1::CheckValidCredsRequest const &request, Options opts={})
	Returns true if valid credentials exist for the given data source and requesting user. More...
Status	EnrollDataSources (google::cloud::bigquery::datatransfer::v1::EnrollDataSourcesRequest const &request, Options opts={})
	Enroll data sources in a user project. More...
Copy and move support
	DataTransferServiceClient (DataTransferServiceClient const &)=default
DataTransferServiceClient &	operator= (DataTransferServiceClient const &)=default
	DataTransferServiceClient (DataTransferServiceClient &&)=default
DataTransferServiceClient &	operator= (DataTransferServiceClient &&)=default

Friends
Equality
bool	operator== (DataTransferServiceClient const &a, DataTransferServiceClient const &b)
bool	operator!= (DataTransferServiceClient const &a, DataTransferServiceClient const &b)

Detailed Description

This API allows users to manage their data transfers into BigQuery.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructor & Destructor Documentation

DataTransferServiceClient() [1/3]

google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DataTransferServiceClient ( std::shared_ptr< DataTransferServiceConnection >  connection, Options  opts = {}  )

explicit

~DataTransferServiceClient()

google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::~DataTransferServiceClient

(

)

DataTransferServiceClient() [2/3]

google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DataTransferServiceClient ( DataTransferServiceClient const &  )

default

DataTransferServiceClient() [3/3]

google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DataTransferServiceClient ( DataTransferServiceClient &&  )

default

Member Function Documentation

CheckValidCreds() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::CheckValidCreds	(	google::cloud::bigquery::datatransfer::v1::CheckValidCredsRequest const &	request,
		Options	opts = {}
	)

Returns true if valid credentials exist for the given data source and requesting user.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CheckValidCreds() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::CheckValidCreds	(	std::string const &	name,
		Options	opts = {}
	)

Returns true if valid credentials exist for the given data source and requesting user.

Parameters

name	Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTransferConfig() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::CreateTransferConfig	(	google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest const &	request,
		Options	opts = {}
	)

Creates a new data transfer configuration.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTransferConfig() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::CreateTransferConfig	(	std::string const &	parent,
		google::cloud::bigquery::datatransfer::v1::TransferConfig const &	transfer_config,
		Options	opts = {}
	)

Creates a new data transfer configuration.

Parameters

parent	Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
transfer_config	Required. Data transfer configuration to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTransferConfig() [1/2]

Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferConfig	(	google::cloud::bigquery::datatransfer::v1::DeleteTransferConfigRequest const &	request,
		Options	opts = {}
	)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTransferConfig() [2/2]

Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferConfig	(	std::string const &	name,
		Options	opts = {}
	)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Parameters

name	Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTransferRun() [1/2]

Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferRun	(	google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest const &	request,
		Options	opts = {}
	)

Deletes the specified transfer run.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTransferRun() [2/2]

Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferRun	(	std::string const &	name,
		Options	opts = {}
	)

Deletes the specified transfer run.

Parameters

name	Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

EnrollDataSources()

Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::EnrollDataSources	(	google::cloud::bigquery::datatransfer::v1::EnrollDataSourcesRequest const &	request,
		Options	opts = {}
	)

Enroll data sources in a user project.

This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

GetDataSource() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetDataSource	(	google::cloud::bigquery::datatransfer::v1::GetDataSourceRequest const &	request,
		Options	opts = {}
	)

Retrieves a supported data source and returns its settings.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.DataSource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDataSource() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetDataSource	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves a supported data source and returns its settings.

Parameters

name	Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.DataSource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTransferConfig() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetTransferConfig	(	google::cloud::bigquery::datatransfer::v1::GetTransferConfigRequest const &	request,
		Options	opts = {}
	)

Returns information about a data transfer config.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTransferConfig() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetTransferConfig	(	std::string const &	name,
		Options	opts = {}
	)

Returns information about a data transfer config.

Parameters

name	Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTransferRun() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetTransferRun	(	google::cloud::bigquery::datatransfer::v1::GetTransferRunRequest const &	request,
		Options	opts = {}
	)

Returns information about the particular transfer run.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTransferRun() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::GetTransferRun	(	std::string const &	name,
		Options	opts = {}
	)

Returns information about the particular transfer run.

Parameters

name	Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDataSources() [1/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListDataSources	(	google::cloud::bigquery::datatransfer::v1::ListDataSourcesRequest	request,
		Options	opts = {}
	)

Lists supported data sources and returns their settings.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.DataSource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDataSources() [2/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListDataSources	(	std::string const &	parent,
		Options	opts = {}
	)

Lists supported data sources and returns their settings.

Parameters

parent	Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or projects/{project_id}/locations/{location_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.DataSource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferConfigs() [1/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferConfigs	(	google::cloud::bigquery::datatransfer::v1::ListTransferConfigsRequest	request,
		Options	opts = {}
	)

Returns information about all transfer configs owned by a project in the specified location.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferConfigs() [2/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferConfigs	(	std::string const &	parent,
		Options	opts = {}
	)

Returns information about all transfer configs owned by a project in the specified location.

Parameters

parent	Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferLogs() [1/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferLogs	(	google::cloud::bigquery::datatransfer::v1::ListTransferLogsRequest	request,
		Options	opts = {}
	)

Returns log messages for the transfer run.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferMessage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferLogs() [2/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferLogs	(	std::string const &	parent,
		Options	opts = {}
	)

Returns log messages for the transfer run.

Parameters

parent	Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferMessage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferRuns() [1/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferRuns	(	google::cloud::bigquery::datatransfer::v1::ListTransferRunsRequest	request,
		Options	opts = {}
	)

Returns information about running and completed transfer runs.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferRun, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferRuns() [2/2]

StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ListTransferRuns	(	std::string const &	parent,
		Options	opts = {}
	)

Returns information about running and completed transfer runs.

Parameters

parent	Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.datatransfer.v1.TransferRun, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

operator=() [1/2]

DataTransferServiceClient & google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::operator= ( DataTransferServiceClient &&  )

default

operator=() [2/2]

DataTransferServiceClient & google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::operator= ( DataTransferServiceClient const &  )

default

ScheduleTransferRuns() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ScheduleTransferRuns	(	google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsRequest const &	request,
		Options	opts = {}
	)

Creates transfer runs for a time range [start_time, end_time].

For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ScheduleTransferRuns() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::ScheduleTransferRuns	(	std::string const &	parent,
		google::protobuf::Timestamp const &	start_time,
		google::protobuf::Timestamp const &	end_time,
		Options	opts = {}
	)

Creates transfer runs for a time range [start_time, end_time].

For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Parameters

parent	Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
start_time	Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".
end_time	Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

StartManualTransferRuns()

StatusOr< google::cloud::bigquery::datatransfer::v1:: StartManualTransferRunsResponse > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::StartManualTransferRuns	(	google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsRequest const &	request,
		Options	opts = {}
	)

Start manual transfer runs to be executed now with schedule_time equal to current time.

The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTransferConfig() [1/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::UpdateTransferConfig	(	google::cloud::bigquery::datatransfer::v1::TransferConfig const &	transfer_config,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates a data transfer configuration.

All fields must be set, even if they are not updated.

Parameters

transfer_config	Required. Data transfer configuration to create.
update_mask	Required. Required list of fields to be updated in this request.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTransferConfig() [2/2]

StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig > google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::UpdateTransferConfig	(	google::cloud::bigquery::datatransfer::v1::UpdateTransferConfigRequest const &	request,
		Options	opts = {}
	)

Updates a data transfer configuration.

All fields must be set, even if they are not updated.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.bigquery.datatransfer.v1.TransferConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Friends And Related Function Documentation

operator!=

bool operator!= ( DataTransferServiceClient const &  a, DataTransferServiceClient const &  b  )

friend

operator==

bool operator== ( DataTransferServiceClient const &  a, DataTransferServiceClient const &  b  )

friend