Class PersistentResourceServiceClient (2.23.0)

A service for managing Vertex AI's machine learning PersistentResource.

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

PersistentResourceServiceClient(PersistentResourceServiceClient const &)

Copy and move support

Parameter
Name Description
PersistentResourceServiceClient const &

PersistentResourceServiceClient(PersistentResourceServiceClient &&)

Copy and move support

Parameter
Name Description
PersistentResourceServiceClient &&

PersistentResourceServiceClient(std::shared_ptr< PersistentResourceServiceConnection >, Options)

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

Operators

operator=(PersistentResourceServiceClient const &)

Copy and move support

Parameter
Name Description
PersistentResourceServiceClient const &
Returns
Type Description
PersistentResourceServiceClient &

operator=(PersistentResourceServiceClient &&)

Copy and move support

Parameter
Name Description
PersistentResourceServiceClient &&
Returns
Type Description
PersistentResourceServiceClient &

Functions

CreatePersistentResource(std::string const &, google::cloud::aiplatform::v1::PersistentResource const &, std::string const &, Options)

Creates a PersistentResource.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}
persistent_resource google::cloud::aiplatform::v1::PersistentResource const &

Required. The PersistentResource to create.

persistent_resource_id std::string const &

Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name.
The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePersistentResource(google::cloud::aiplatform::v1::CreatePersistentResourceRequest const &, Options)

Creates a PersistentResource.

Parameters
Name Description
request google::cloud::aiplatform::v1::CreatePersistentResourceRequest 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.aiplatform.v1.CreatePersistentResourceRequest. 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
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetPersistentResource(std::string const &, Options)

Gets a PersistentResource.

Parameters
Name Description
name std::string const &

Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::aiplatform::v1::PersistentResource >

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

GetPersistentResource(google::cloud::aiplatform::v1::GetPersistentResourceRequest const &, Options)

Gets a PersistentResource.

Parameters
Name Description
request google::cloud::aiplatform::v1::GetPersistentResourceRequest 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.aiplatform.v1.GetPersistentResourceRequest. 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::aiplatform::v1::PersistentResource >

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

ListPersistentResources(std::string const &, Options)

Lists PersistentResources in a Location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to list the PersistentResources from. Format: projects/{project}/locations/{location}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::aiplatform::v1::PersistentResource >

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

ListPersistentResources(google::cloud::aiplatform::v1::ListPersistentResourcesRequest, Options)

Lists PersistentResources in a Location.

Parameters
Name Description
request google::cloud::aiplatform::v1::ListPersistentResourcesRequest

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.aiplatform.v1.ListPersistentResourcesRequest. 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::aiplatform::v1::PersistentResource >

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

DeletePersistentResource(std::string const &, Options)

Deletes a PersistentResource.

Parameters
Name Description
name std::string const &

Required. The name of the PersistentResource to be deleted. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePersistentResource(google::cloud::aiplatform::v1::DeletePersistentResourceRequest const &, Options)

Deletes a PersistentResource.

Parameters
Name Description
request google::cloud::aiplatform::v1::DeletePersistentResourceRequest 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.aiplatform.v1.DeletePersistentResourceRequest. 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
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePersistentResource(google::cloud::aiplatform::v1::PersistentResource const &, google::protobuf::FieldMask const &, Options)

Updates a PersistentResource.

Parameters
Name Description
persistent_resource google::cloud::aiplatform::v1::PersistentResource const &

Required. The PersistentResource to update.
The PersistentResource's name field is used to identify the PersistentResource to update. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}
update_mask google::protobuf::FieldMask const &

Required. Specify the fields to be overwritten in the PersistentResource by the update method.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePersistentResource(google::cloud::aiplatform::v1::UpdatePersistentResourceRequest const &, Options)

Updates a PersistentResource.

Parameters
Name Description
request google::cloud::aiplatform::v1::UpdatePersistentResourceRequest 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.aiplatform.v1.UpdatePersistentResourceRequest. 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
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RebootPersistentResource(std::string const &, Options)

Reboots a PersistentResource.

Parameters
Name Description
name std::string const &

Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RebootPersistentResource(google::cloud::aiplatform::v1::RebootPersistentResourceRequest const &, Options)

Reboots a PersistentResource.

Parameters
Name Description
request google::cloud::aiplatform::v1::RebootPersistentResourceRequest 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.aiplatform.v1.RebootPersistentResourceRequest. 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
future< StatusOr< google::cloud::aiplatform::v1::PersistentResource > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PersistentResource proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.