Class DeploymentClient (2.42.0-rc)

Service describing handlers for resources.

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

DeploymentClient(DeploymentClient const &)

Copy and move support

Parameter
Name Description
DeploymentClient const &

DeploymentClient(DeploymentClient &&)

Copy and move support

Parameter
Name Description
DeploymentClient &&

DeploymentClient(std::shared_ptr< DeploymentConnection >, Options)

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

Operators

operator=(DeploymentClient const &)

Copy and move support

Parameter
Name Description
DeploymentClient const &
Returns
Type Description
DeploymentClient &

operator=(DeploymentClient &&)

Copy and move support

Parameter
Name Description
DeploymentClient &&
Returns
Type Description
DeploymentClient &

Functions

CreateFrameworkDeployment(std::string const &, google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment const &, std::string const &, Options)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

framework_deployment google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment const &

Required. The resource being created.

framework_deployment_id std::string const &

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment > >

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.cloudsecuritycompliance.v1.FrameworkDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFrameworkDeployment(NoAwaitTag, std::string const &, google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment const &, std::string const &, Options)

Creates a new FrameworkDeployment 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 &
framework_deployment google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment const &
framework_deployment_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFrameworkDeployment(google::cloud::cloudsecuritycompliance::v1::CreateFrameworkDeploymentRequest const &, Options)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::CreateFrameworkDeploymentRequest 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.cloudsecuritycompliance.v1.CreateFrameworkDeploymentRequest. 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::cloudsecuritycompliance::v1::FrameworkDeployment > >

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.cloudsecuritycompliance.v1.FrameworkDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFrameworkDeployment(NoAwaitTag, google::cloud::cloudsecuritycompliance::v1::CreateFrameworkDeploymentRequest const &, Options)

Creates a new FrameworkDeployment 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::cloudsecuritycompliance::v1::CreateFrameworkDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFrameworkDeployment(google::longrunning::Operation const &, Options)

Creates a new FrameworkDeployment 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::cloudsecuritycompliance::v1::FrameworkDeployment > >

DeleteFrameworkDeployment(std::string const &, Options)

Deletes a single FrameworkDeployment.

Parameters
Name Description
name std::string const &

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::cloudsecuritycompliance::v1::OperationMetadata > >

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.cloudsecuritycompliance.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteFrameworkDeployment(NoAwaitTag, std::string const &, Options)

Deletes a single FrameworkDeployment.

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 >

DeleteFrameworkDeployment(google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkDeploymentRequest const &, Options)

Deletes a single FrameworkDeployment.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkDeploymentRequest 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.cloudsecuritycompliance.v1.DeleteFrameworkDeploymentRequest. 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::cloudsecuritycompliance::v1::OperationMetadata > >

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.cloudsecuritycompliance.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteFrameworkDeployment(NoAwaitTag, google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkDeploymentRequest const &, Options)

Deletes a single FrameworkDeployment.

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::cloudsecuritycompliance::v1::DeleteFrameworkDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteFrameworkDeployment(google::longrunning::Operation const &, Options)

Deletes a single FrameworkDeployment.

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::cloudsecuritycompliance::v1::OperationMetadata > >

GetFrameworkDeployment(std::string const &, Options)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name std::string const &

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment >

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

GetFrameworkDeployment(google::cloud::cloudsecuritycompliance::v1::GetFrameworkDeploymentRequest const &, Options)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::GetFrameworkDeploymentRequest 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.cloudsecuritycompliance.v1.GetFrameworkDeploymentRequest. 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::cloudsecuritycompliance::v1::FrameworkDeployment >

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

ListFrameworkDeployments(std::string const &, Options)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListFrameworkDeploymentsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::cloudsecuritycompliance::v1::FrameworkDeployment >

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

ListFrameworkDeployments(google::cloud::cloudsecuritycompliance::v1::ListFrameworkDeploymentsRequest, Options)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::ListFrameworkDeploymentsRequest

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.cloudsecuritycompliance.v1.ListFrameworkDeploymentsRequest. 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::cloudsecuritycompliance::v1::FrameworkDeployment >

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

GetCloudControlDeployment(std::string const &, Options)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name std::string const &

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudsecuritycompliance::v1::CloudControlDeployment >

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

GetCloudControlDeployment(google::cloud::cloudsecuritycompliance::v1::GetCloudControlDeploymentRequest const &, Options)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::GetCloudControlDeploymentRequest 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.cloudsecuritycompliance.v1.GetCloudControlDeploymentRequest. 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::cloudsecuritycompliance::v1::CloudControlDeployment >

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

ListCloudControlDeployments(std::string const &, Options)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListCloudControlDeploymentsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::cloudsecuritycompliance::v1::CloudControlDeployment >

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

ListCloudControlDeployments(google::cloud::cloudsecuritycompliance::v1::ListCloudControlDeploymentsRequest, Options)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::ListCloudControlDeploymentsRequest

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.cloudsecuritycompliance.v1.ListCloudControlDeploymentsRequest. 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::cloudsecuritycompliance::v1::CloudControlDeployment >

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. 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::location::Location >

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. 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::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 StatusOr contains the error details.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. 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::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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. 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.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. 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.