Service describing handlers for resources Configures and manages parallelstore resources.
Parallelstore service.
The parallelstore.googleapis.com
service implements the parallelstore API and defines the following resource model for managing instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of instances named
/instances/*
. - Parallelstore instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a Google Cloud zone
; for example:
projects/12345/locations/us-central1-c/instances/my-parallelstore-share
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
ParallelstoreClient(ParallelstoreClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParallelstoreClient const &
|
ParallelstoreClient(ParallelstoreClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParallelstoreClient &&
|
ParallelstoreClient(std::shared_ptr< ParallelstoreConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ParallelstoreConnection >
|
opts |
Options
|
Operators
operator=(ParallelstoreClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParallelstoreClient const &
|
Returns | |
---|---|
Type | Description |
ParallelstoreClient & |
operator=(ParallelstoreClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParallelstoreClient &&
|
Returns | |
---|---|
Type | Description |
ParallelstoreClient & |
Functions
ListInstances(std::string const &, Options)
Lists all instances in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve instance information, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::parallelstore::v1::Instance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListInstances(google::cloud::parallelstore::v1::ListInstancesRequest, Options)
Lists all instances in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::ListInstancesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::parallelstore::v1::Instance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetInstance(std::string const &, Options)
Gets details of a single instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The instance resource name, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::parallelstore::v1::Instance > |
the result of the RPC. The response message type (google.cloud.parallelstore.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstance(google::cloud::parallelstore::v1::GetInstanceRequest const &, Options)
Gets details of a single instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::GetInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::parallelstore::v1::Instance > |
the result of the RPC. The response message type (google.cloud.parallelstore.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateInstance(std::string const &, google::cloud::parallelstore::v1::Instance const &, std::string const &, Options)
Creates a Parallelstore instance in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The instance's project and location, in the format |
instance |
google::cloud::parallelstore::v1::Instance const &
Required. The instance to create. |
instance_id |
std::string const &
Required. The name of the Parallelstore instance.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
A |
CreateInstance(NoAwaitTag, std::string const &, google::cloud::parallelstore::v1::Instance const &, std::string const &, Options)
Creates a Parallelstore instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
instance |
google::cloud::parallelstore::v1::Instance const &
|
instance_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::cloud::parallelstore::v1::CreateInstanceRequest const &, Options)
Creates a Parallelstore instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::CreateInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
A |
CreateInstance(NoAwaitTag, google::cloud::parallelstore::v1::CreateInstanceRequest const &, Options)
Creates a Parallelstore instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::parallelstore::v1::CreateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::longrunning::Operation const &, Options)
Creates a Parallelstore instance in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
UpdateInstance(google::cloud::parallelstore::v1::Instance const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single instance.
Parameters | |
---|---|
Name | Description |
instance |
google::cloud::parallelstore::v1::Instance const &
Required. The instance to update. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the update_mask are relative to the resource, not the full request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
A |
UpdateInstance(NoAwaitTag, google::cloud::parallelstore::v1::Instance const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
instance |
google::cloud::parallelstore::v1::Instance const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(google::cloud::parallelstore::v1::UpdateInstanceRequest const &, Options)
Updates the parameters of a single instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::UpdateInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
A |
UpdateInstance(NoAwaitTag, google::cloud::parallelstore::v1::UpdateInstanceRequest const &, Options)
Updates the parameters of a single instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::parallelstore::v1::UpdateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(google::longrunning::Operation const &, Options)
Updates the parameters of a single instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::Instance > > |
DeleteInstance(std::string const &, Options)
Deletes a single instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::OperationMetadata > > |
A |
DeleteInstance(NoAwaitTag, std::string const &, Options)
Deletes a single instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteInstance(google::cloud::parallelstore::v1::DeleteInstanceRequest const &, Options)
Deletes a single instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::DeleteInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::OperationMetadata > > |
A |
DeleteInstance(NoAwaitTag, google::cloud::parallelstore::v1::DeleteInstanceRequest const &, Options)
Deletes a single instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::parallelstore::v1::DeleteInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteInstance(google::longrunning::Operation const &, Options)
Deletes a single instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::OperationMetadata > > |
ImportData(google::cloud::parallelstore::v1::ImportDataRequest const &, Options)
Copies data from Cloud Storage to Parallelstore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::ImportDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::ImportDataResponse > > |
A |
ImportData(NoAwaitTag, google::cloud::parallelstore::v1::ImportDataRequest const &, Options)
Copies data from Cloud Storage to Parallelstore.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::parallelstore::v1::ImportDataRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportData(google::longrunning::Operation const &, Options)
Copies data from Cloud Storage to Parallelstore.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::ImportDataResponse > > |
ExportData(google::cloud::parallelstore::v1::ExportDataRequest const &, Options)
Copies data from Parallelstore to Cloud Storage.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::parallelstore::v1::ExportDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::ExportDataResponse > > |
A |
ExportData(NoAwaitTag, google::cloud::parallelstore::v1::ExportDataRequest const &, Options)
Copies data from Parallelstore to Cloud Storage.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::parallelstore::v1::ExportDataRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ExportData(google::longrunning::Operation const &, Options)
Copies data from Parallelstore to Cloud Storage.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::parallelstore::v1::ExportDataResponse > > |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |