Class DataTransferServiceClient (2.30.0)

Version 2.30.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 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.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Constructors

DataTransferServiceClient(DataTransferServiceClient const &)

Copy and move support

Parameter
Name	Description
	DataTransferServiceClient const &

DataTransferServiceClient(DataTransferServiceClient &&)

Copy and move support

Parameter
Name	Description
	DataTransferServiceClient &&

DataTransferServiceClient(std::shared_ptr< DataTransferServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< DataTransferServiceConnection >
opts	Options

Operators

operator=(DataTransferServiceClient const &)

Copy and move support

Parameter
Name	Description
	DataTransferServiceClient const &

Returns
Type	Description
DataTransferServiceClient &

operator=(DataTransferServiceClient &&)

Copy and move support

Parameter
Name	Description
	DataTransferServiceClient &&

Returns
Type	Description
DataTransferServiceClient &

Functions

GetDataSource(std::string const &, Options)

Retrieves a supported data source and returns its settings.

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource >	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(google::cloud::bigquery::datatransfer::v1::GetDataSourceRequest const &, Options)

Retrieves a supported data source and returns its settings.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::GetDataSourceRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::DataSource >	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.

ListDataSources(std::string const &, Options)

Lists supported data sources and returns their settings.

Parameters
Name	Description
parent	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource >	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(google::cloud::bigquery::datatransfer::v1::ListDataSourcesRequest, Options)

Lists supported data sources and returns their settings.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::ListDataSourcesRequest 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::DataSource >	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.

CreateTransferConfig(std::string const &, google::cloud::bigquery::datatransfer::v1::TransferConfig const &, Options)

Creates a new data transfer configuration.

Parameters
Name	Description
parent	std::string const & 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	google::cloud::bigquery::datatransfer::v1::TransferConfig const & Required. Data transfer configuration to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest const &, Options)

Creates a new data transfer configuration.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(google::cloud::bigquery::datatransfer::v1::TransferConfig const &, google::protobuf::FieldMask const &, Options)

Updates a data transfer configuration.

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

Parameters
Name	Description
transfer_config	google::cloud::bigquery::datatransfer::v1::TransferConfig const & Required. Data transfer configuration to create.
update_mask	google::protobuf::FieldMask const & Required. Required list of fields to be updated in this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(google::cloud::bigquery::datatransfer::v1::UpdateTransferConfigRequest const &, Options)

Updates a data transfer configuration.

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

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::UpdateTransferConfigRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(std::string const &, Options)

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

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteTransferConfig(google::cloud::bigquery::datatransfer::v1::DeleteTransferConfigRequest const &, Options)

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

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::DeleteTransferConfigRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

GetTransferConfig(std::string const &, Options)

Returns information about a data transfer config.

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(google::cloud::bigquery::datatransfer::v1::GetTransferConfigRequest const &, Options)

Returns information about a data transfer config.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::GetTransferConfigRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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.

ListTransferConfigs(std::string const &, Options)

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

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

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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(google::cloud::bigquery::datatransfer::v1::ListTransferConfigsRequest, Options)

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

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::ListTransferConfigsRequest 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferConfig >	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.

ScheduleTransferRuns(std::string const &, google::protobuf::Timestamp const &, google::protobuf::Timestamp const &, Options)

Deprecated: This RPC is deprecated.

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
Name	Description
parent	std::string const & 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	google::protobuf::Timestamp const & Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".
end_time	google::protobuf::Timestamp const & Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse >	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(google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsRequest const &, Options)

Deprecated: This RPC is deprecated.

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
Name	Description
request	google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsResponse >	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(google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsRequest const &, Options)

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
Name	Description
request	google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsResponse >	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.

GetTransferRun(std::string const &, Options)

Returns information about the particular transfer run.

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun >	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(google::cloud::bigquery::datatransfer::v1::GetTransferRunRequest const &, Options)

Returns information about the particular transfer run.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::GetTransferRunRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::TransferRun >	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.

DeleteTransferRun(std::string const &, Options)

Deletes the specified transfer run.

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteTransferRun(google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest const &, Options)

Deletes the specified transfer run.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

ListTransferRuns(std::string const &, Options)

Returns information about running and completed transfer runs.

Parameters
Name	Description
parent	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun >	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(google::cloud::bigquery::datatransfer::v1::ListTransferRunsRequest, Options)

Returns information about running and completed transfer runs.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::ListTransferRunsRequest 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferRun >	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.

ListTransferLogs(std::string const &, Options)

Returns log messages for the transfer run.

Parameters
Name	Description
parent	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage >	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(google::cloud::bigquery::datatransfer::v1::ListTransferLogsRequest, Options)

Returns log messages for the transfer run.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::ListTransferLogsRequest 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::datatransfer::v1::TransferMessage >	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.

CheckValidCreds(std::string const &, Options)

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

Parameters
Name	Description
name	std::string const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse >	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(google::cloud::bigquery::datatransfer::v1::CheckValidCredsRequest const &, Options)

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

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::CheckValidCredsRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::datatransfer::v1::CheckValidCredsResponse >	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.

EnrollDataSources(google::cloud::bigquery::datatransfer::v1::EnrollDataSourcesRequest const &, Options)

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
Name	Description
request	google::cloud::bigquery::datatransfer::v1::EnrollDataSourcesRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

UnenrollDataSources(google::cloud::bigquery::datatransfer::v1::UnenrollDataSourcesRequest const &, Options)

Unenroll data sources in a user project.

This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

Parameters
Name	Description
request	google::cloud::bigquery::datatransfer::v1::UnenrollDataSourcesRequest const & 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.UnenrollDataSourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.