The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.
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
AttachedClustersClient(AttachedClustersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AttachedClustersClient const &
|
AttachedClustersClient(AttachedClustersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AttachedClustersClient &&
|
AttachedClustersClient(std::shared_ptr< AttachedClustersConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AttachedClustersConnection >
|
opts |
Options
|
Operators
operator=(AttachedClustersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AttachedClustersClient const &
|
Returns | |
---|---|
Type | Description |
AttachedClustersClient & |
operator=(AttachedClustersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AttachedClustersClient &&
|
Returns | |
---|---|
Type | Description |
AttachedClustersClient & |
Functions
CreateAttachedCluster(std::string const &, google::cloud::gkemulticloud::v1::AttachedCluster const &, std::string const &, Options)
Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location where this AttachedCluster resource will be created. |
attached_cluster |
google::cloud::gkemulticloud::v1::AttachedCluster const &
Required. The specification of the AttachedCluster to create. |
attached_cluster_id |
std::string const &
Required. A client provided ID the resource. Must be unique within the parent resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > > |
A |
CreateAttachedCluster(NoAwaitTag, std::string const &, google::cloud::gkemulticloud::v1::AttachedCluster const &, std::string const &, Options)
Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.
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 &
|
attached_cluster |
google::cloud::gkemulticloud::v1::AttachedCluster const &
|
attached_cluster_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateAttachedCluster(google::cloud::gkemulticloud::v1::CreateAttachedClusterRequest const &, Options)
Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::CreateAttachedClusterRequest 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::gkemulticloud::v1::AttachedCluster > > |
A |
CreateAttachedCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::CreateAttachedClusterRequest const &, Options)
Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.
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::gkemulticloud::v1::CreateAttachedClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateAttachedCluster(google::longrunning::Operation const &, Options)
Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.
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::gkemulticloud::v1::AttachedCluster > > |
UpdateAttachedCluster(google::cloud::gkemulticloud::v1::AttachedCluster const &, google::protobuf::FieldMask const &, Options)
Updates an AttachedCluster.
Parameters | |
---|---|
Name | Description |
attached_cluster |
google::cloud::gkemulticloud::v1::AttachedCluster const &
Required. The AttachedCluster resource to update. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > > |
A |
UpdateAttachedCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::AttachedCluster const &, google::protobuf::FieldMask const &, Options)
Updates an AttachedCluster.
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
|
attached_cluster |
google::cloud::gkemulticloud::v1::AttachedCluster const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateAttachedCluster(google::cloud::gkemulticloud::v1::UpdateAttachedClusterRequest const &, Options)
Updates an AttachedCluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::UpdateAttachedClusterRequest 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::gkemulticloud::v1::AttachedCluster > > |
A |
UpdateAttachedCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::UpdateAttachedClusterRequest const &, Options)
Updates an AttachedCluster.
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::gkemulticloud::v1::UpdateAttachedClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateAttachedCluster(google::longrunning::Operation const &, Options)
Updates an AttachedCluster.
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::gkemulticloud::v1::AttachedCluster > > |
ImportAttachedCluster(std::string const &, std::string const &, Options)
Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location where this AttachedCluster resource will be created. |
fleet_membership |
std::string const &
Required. The name of the fleet membership resource to import. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > > |
A |
ImportAttachedCluster(NoAwaitTag, std::string const &, std::string const &, Options)
Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
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 &
|
fleet_membership |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportAttachedCluster(google::cloud::gkemulticloud::v1::ImportAttachedClusterRequest const &, Options)
Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::ImportAttachedClusterRequest 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::gkemulticloud::v1::AttachedCluster > > |
A |
ImportAttachedCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::ImportAttachedClusterRequest const &, Options)
Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
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::gkemulticloud::v1::ImportAttachedClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportAttachedCluster(google::longrunning::Operation const &, Options)
Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
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::gkemulticloud::v1::AttachedCluster > > |
GetAttachedCluster(std::string const &, Options)
Describes a specific AttachedCluster resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AttachedCluster resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAttachedCluster(google::cloud::gkemulticloud::v1::GetAttachedClusterRequest const &, Options)
Describes a specific AttachedCluster resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAttachedClusterRequest 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::gkemulticloud::v1::AttachedCluster > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAttachedClusters(std::string const &, Options)
Lists all AttachedCluster resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location which owns this collection of AttachedCluster resources. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AttachedCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAttachedClusters(google::cloud::gkemulticloud::v1::ListAttachedClustersRequest, Options)
Lists all AttachedCluster resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::ListAttachedClustersRequest
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::gkemulticloud::v1::AttachedCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAttachedCluster(std::string const &, Options)
Deletes a specific AttachedCluster resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name the AttachedCluster to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
DeleteAttachedCluster(NoAwaitTag, std::string const &, Options)
Deletes a specific AttachedCluster resource.
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 > |
DeleteAttachedCluster(google::cloud::gkemulticloud::v1::DeleteAttachedClusterRequest const &, Options)
Deletes a specific AttachedCluster resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::DeleteAttachedClusterRequest 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::gkemulticloud::v1::OperationMetadata > > |
A |
DeleteAttachedCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::DeleteAttachedClusterRequest const &, Options)
Deletes a specific AttachedCluster resource.
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::gkemulticloud::v1::DeleteAttachedClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteAttachedCluster(google::longrunning::Operation const &, Options)
Deletes a specific AttachedCluster resource.
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::gkemulticloud::v1::OperationMetadata > > |
GetAttachedServerConfig(std::string const &, Options)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AttachedServerConfig resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AttachedServerConfig > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAttachedServerConfig(google::cloud::gkemulticloud::v1::GetAttachedServerConfigRequest const &, Options)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAttachedServerConfigRequest 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::gkemulticloud::v1::AttachedServerConfig > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateAttachedClusterInstallManifest(std::string const &, std::string const &, Options)
Generates the install manifest to be installed on the target cluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location where this AttachedCluster resource will be created. |
attached_cluster_id |
std::string const &
Required. A client provided ID of the resource. Must be unique within the parent resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestResponse > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateAttachedClusterInstallManifest(google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestRequest const &, Options)
Generates the install manifest to be installed on the target cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestRequest 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::gkemulticloud::v1::GenerateAttachedClusterInstallManifestResponse > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateAttachedClusterAgentToken(google::cloud::gkemulticloud::v1::GenerateAttachedClusterAgentTokenRequest const &, Options)
Generates an access token for a cluster agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GenerateAttachedClusterAgentTokenRequest 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::gkemulticloud::v1::GenerateAttachedClusterAgentTokenResponse > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAttachedClusterAgentTokenResponse) 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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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 |