Class ModelServiceClient (2.30.0)

This is an experimental RPC service definition for the BigQuery Model Service.

It should not be relied on for production use cases at this time.

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

ModelServiceClient(ModelServiceClient const &)

Copy and move support

Parameter
Name Description
ModelServiceClient const &

ModelServiceClient(ModelServiceClient &&)

Copy and move support

Parameter
Name Description
ModelServiceClient &&

ModelServiceClient(std::shared_ptr< ModelServiceConnection >, Options)

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

Operators

operator=(ModelServiceClient const &)

Copy and move support

Parameter
Name Description
ModelServiceClient const &
Returns
Type Description
ModelServiceClient &

operator=(ModelServiceClient &&)

Copy and move support

Parameter
Name Description
ModelServiceClient &&
Returns
Type Description
ModelServiceClient &

Functions

GetModel(std::string const &, std::string const &, std::string const &, Options)

Gets the specified model resource by model ID.

Parameters
Name Description
project_id std::string const &

Required. Project ID of the requested model.

dataset_id std::string const &

Required. Dataset ID of the requested model.

model_id std::string const &

Required. Model ID of the requested model.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::bigquery::v2::Model >

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

GetModel(google::cloud::bigquery::v2::GetModelRequest const &, Options)

Gets the specified model resource by model ID.

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

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

ListModels(std::string const &, std::string const &, google::protobuf::UInt32Value const &, Options)

Lists all models in the specified dataset.

Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.

Parameters
Name Description
project_id std::string const &

Required. Project ID of the models to list.

dataset_id std::string const &

Required. Dataset ID of the models to list.

max_results google::protobuf::UInt32Value const &

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::bigquery::v2::Model >

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.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListModels(google::cloud::bigquery::v2::ListModelsRequest, Options)

Lists all models in the specified dataset.

Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.

Parameters
Name Description
request google::cloud::bigquery::v2::ListModelsRequest

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.ListModelsRequest. 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::Model >

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.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

PatchModel(std::string const &, std::string const &, std::string const &, google::cloud::bigquery::v2::Model const &, Options)

Patch specific fields in the specified model.

Parameters
Name Description
project_id std::string const &

Required. Project ID of the model to patch.

dataset_id std::string const &

Required. Dataset ID of the model to patch.

model_id std::string const &

Required. Model ID of the model to patch.

model google::cloud::bigquery::v2::Model const &

Required. Patched model. Follows RFC5789 patch semantics. Missing fields are not updated. To clear a field, explicitly set to default value.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::bigquery::v2::Model >

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

PatchModel(google::cloud::bigquery::v2::PatchModelRequest const &, Options)

Patch specific fields in the specified model.

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

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

DeleteModel(std::string const &, std::string const &, std::string const &, Options)

Deletes the model specified by modelId from the dataset.

Parameters
Name Description
project_id std::string const &

Required. Project ID of the model to delete.

dataset_id std::string const &

Required. Dataset ID of the model to delete.

model_id std::string const &

Required. Model ID of the model to delete.

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.

DeleteModel(google::cloud::bigquery::v2::DeleteModelRequest const &, Options)

Deletes the model specified by modelId from the dataset.

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