Google Cloud BigQuery C++ Client 2.10.1
A C++ Client Library for Google Cloud BigQuery
|
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) |
This API allows users to manage their data transfers into BigQuery.
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.
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.
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.
|
explicit |
google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::~DataTransferServiceClient | ( | ) |
|
default |
|
default |
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.
request | google::cloud::bigquery::datatransfer::v1::CheckValidCredsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::DeleteTransferConfigRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferRun | ( | google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest const & | request, |
Options | opts = {} |
||
) |
Deletes the specified transfer run.
request | google::cloud::bigquery::datatransfer::v1::DeleteTransferRunRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::bigquery_datatransfer_v1::DataTransferServiceClient::DeleteTransferRun | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Deletes the specified transfer run.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::EnrollDataSourcesRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
request | google::cloud::bigquery::datatransfer::v1::GetDataSourceRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::GetTransferConfigRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::GetTransferRunRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::ListDataSourcesRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::ListTransferConfigsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::ListTransferLogsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::ListTransferRunsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
|
default |
|
default |
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.
request | google::cloud::bigquery::datatransfer::v1::ScheduleTransferRunsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::StartManualTransferRunsRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | google::cloud::bigquery::datatransfer::v1::UpdateTransferConfigRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
|
friend |
|
friend |