Class DatasetServiceClient (2.33.0)

Version 2.33.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0

DatasetService provides methods for managing BigQuery datasets.

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

DatasetServiceClient(DatasetServiceClient const &)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient const &

DatasetServiceClient(DatasetServiceClient &&)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient &&

DatasetServiceClient(std::shared_ptr< DatasetServiceConnection >, Options)

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

Operators

operator=(DatasetServiceClient const &)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient const &

Returns
Type	Description
DatasetServiceClient &

operator=(DatasetServiceClient &&)

Copy and move support

Parameter
Name	Description
	DatasetServiceClient &&

Returns
Type	Description
DatasetServiceClient &

Functions

GetDataset(google::cloud::bigquery::v2::GetDatasetRequest const &, Options)

Returns the dataset specified by datasetID.

Parameters
Name	Description
request	google::cloud::bigquery::v2::GetDatasetRequest 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.v2.GetDatasetRequest. 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::v2::Dataset >	the result of the RPC. The response message type (google.cloud.bigquery.v2.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertDataset(google::cloud::bigquery::v2::InsertDatasetRequest const &, Options)

Creates a new empty dataset.

Parameters
Name	Description
request	google::cloud::bigquery::v2::InsertDatasetRequest 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.v2.InsertDatasetRequest. 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::v2::Dataset >	the result of the RPC. The response message type (google.cloud.bigquery.v2.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PatchDataset(google::cloud::bigquery::v2::UpdateOrPatchDatasetRequest const &, Options)

Updates information in an existing dataset.

The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics.

Parameters
Name	Description
request	google::cloud::bigquery::v2::UpdateOrPatchDatasetRequest 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.v2.UpdateOrPatchDatasetRequest. 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::v2::Dataset >	the result of the RPC. The response message type (google.cloud.bigquery.v2.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDataset(google::cloud::bigquery::v2::UpdateOrPatchDatasetRequest const &, Options)

Updates information in an existing dataset.

The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

Parameters
Name	Description
request	google::cloud::bigquery::v2::UpdateOrPatchDatasetRequest 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.v2.UpdateOrPatchDatasetRequest. 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::v2::Dataset >	the result of the RPC. The response message type (google.cloud.bigquery.v2.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteDataset(google::cloud::bigquery::v2::DeleteDatasetRequest const &, Options)

Deletes the dataset specified by the datasetId value.

Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.

Parameters
Name	Description
request	google::cloud::bigquery::v2::DeleteDatasetRequest 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.v2.DeleteDatasetRequest. 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.

ListDatasets(google::cloud::bigquery::v2::ListDatasetsRequest, Options)

Lists all datasets in the specified project to which the user has been granted the READER dataset role.

Parameters
Name	Description
request	google::cloud::bigquery::v2::ListDatasetsRequest 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.v2.ListDatasetsRequest. 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::v2::ListFormatDataset >	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.v2.ListFormatDataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UndeleteDataset(google::cloud::bigquery::v2::UndeleteDatasetRequest const &, Options)

Undeletes a dataset which is within time travel window based on datasetId.

If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted.

Parameters
Name	Description
request	google::cloud::bigquery::v2::UndeleteDatasetRequest 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.v2.UndeleteDatasetRequest. 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::v2::Dataset >	the result of the RPC. The response message type (google.cloud.bigquery.v2.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.