DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g.
Data Profile, Data Quality) for the data source.
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
DataScanServiceClient(DataScanServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataScanServiceClient const &
|
DataScanServiceClient(DataScanServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataScanServiceClient &&
|
DataScanServiceClient(std::shared_ptr< DataScanServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< DataScanServiceConnection >
|
opts |
Options
|
Operators
operator=(DataScanServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataScanServiceClient const &
|
Returns | |
---|---|
Type | Description |
DataScanServiceClient & |
operator=(DataScanServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataScanServiceClient &&
|
Returns | |
---|---|
Type | Description |
DataScanServiceClient & |
Functions
CreateDataScan(std::string const &, google::cloud::dataplex::v1::DataScan const &, std::string const &, Options)
Creates a DataScan resource.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the parent location: |
data_scan |
google::cloud::dataplex::v1::DataScan const &
Required. DataScan resource. |
data_scan_id |
std::string const &
Required. DataScan identifier.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataplex::v1::DataScan > > |
A |
CreateDataScan(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::DataScan const &, std::string const &, Options)
Creates a DataScan 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 &
|
data_scan |
google::cloud::dataplex::v1::DataScan const &
|
data_scan_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateDataScan(google::cloud::dataplex::v1::CreateDataScanRequest const &, Options)
Creates a DataScan resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::CreateDataScanRequest 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::dataplex::v1::DataScan > > |
A |
CreateDataScan(NoAwaitTag, google::cloud::dataplex::v1::CreateDataScanRequest const &, Options)
Creates a DataScan 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::dataplex::v1::CreateDataScanRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateDataScan(google::longrunning::Operation const &, Options)
Creates a DataScan 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::dataplex::v1::DataScan > > |
UpdateDataScan(google::cloud::dataplex::v1::DataScan const &, google::protobuf::FieldMask const &, Options)
Updates a DataScan resource.
Parameters | |
---|---|
Name | Description |
data_scan |
google::cloud::dataplex::v1::DataScan const &
Required. DataScan resource to be updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask of fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataplex::v1::DataScan > > |
A |
UpdateDataScan(NoAwaitTag, google::cloud::dataplex::v1::DataScan const &, google::protobuf::FieldMask const &, Options)
Updates a DataScan 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
|
data_scan |
google::cloud::dataplex::v1::DataScan const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDataScan(google::cloud::dataplex::v1::UpdateDataScanRequest const &, Options)
Updates a DataScan resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::UpdateDataScanRequest 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::dataplex::v1::DataScan > > |
A |
UpdateDataScan(NoAwaitTag, google::cloud::dataplex::v1::UpdateDataScanRequest const &, Options)
Updates a DataScan 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::dataplex::v1::UpdateDataScanRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDataScan(google::longrunning::Operation const &, Options)
Updates a DataScan 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::dataplex::v1::DataScan > > |
DeleteDataScan(std::string const &, Options)
Deletes a DataScan resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the dataScan: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > > |
A |
DeleteDataScan(NoAwaitTag, std::string const &, Options)
Deletes a DataScan 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 > |
DeleteDataScan(google::cloud::dataplex::v1::DeleteDataScanRequest const &, Options)
Deletes a DataScan resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::DeleteDataScanRequest 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::dataplex::v1::OperationMetadata > > |
A |
DeleteDataScan(NoAwaitTag, google::cloud::dataplex::v1::DeleteDataScanRequest const &, Options)
Deletes a DataScan 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::dataplex::v1::DeleteDataScanRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteDataScan(google::longrunning::Operation const &, Options)
Deletes a DataScan 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::dataplex::v1::OperationMetadata > > |
GetDataScan(std::string const &, Options)
Gets a DataScan resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the dataScan: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataplex::v1::DataScan > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataScan(google::cloud::dataplex::v1::GetDataScanRequest const &, Options)
Gets a DataScan resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::GetDataScanRequest 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::dataplex::v1::DataScan > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListDataScans(std::string const &, Options)
Lists DataScans.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the parent location: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataplex::v1::DataScan > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDataScans(google::cloud::dataplex::v1::ListDataScansRequest, Options)
Lists DataScans.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::ListDataScansRequest
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::dataplex::v1::DataScan > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
RunDataScan(std::string const &, Options)
Runs an on-demand execution of a DataScan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the DataScan: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataplex::v1::RunDataScanResponse > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.RunDataScanResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RunDataScan(google::cloud::dataplex::v1::RunDataScanRequest const &, Options)
Runs an on-demand execution of a DataScan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::RunDataScanRequest 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::dataplex::v1::RunDataScanResponse > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.RunDataScanResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataScanJob(std::string const &, Options)
Gets a DataScanJob resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the DataScanJob: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataplex::v1::DataScanJob > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScanJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataScanJob(google::cloud::dataplex::v1::GetDataScanJobRequest const &, Options)
Gets a DataScanJob resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::GetDataScanJobRequest 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::dataplex::v1::DataScanJob > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScanJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListDataScanJobs(std::string const &, Options)
Lists DataScanJobs under the given DataScan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the parent environment: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataplex::v1::DataScanJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDataScanJobs(google::cloud::dataplex::v1::ListDataScanJobsRequest, Options)
Lists DataScanJobs under the given DataScan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::ListDataScanJobsRequest
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::dataplex::v1::DataScanJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GenerateDataQualityRules(std::string const &, Options)
Generates recommended data quality rules based on the results of a data profiling scan.
Use the recommendations to build rules for a data quality scan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name must be one of the following:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataplex::v1::GenerateDataQualityRulesResponse > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.GenerateDataQualityRulesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateDataQualityRules(google::cloud::dataplex::v1::GenerateDataQualityRulesRequest const &, Options)
Generates recommended data quality rules based on the results of a data profiling scan.
Use the recommendations to build rules for a data quality scan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataplex::v1::GenerateDataQualityRulesRequest 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::dataplex::v1::GenerateDataQualityRulesResponse > |
the result of the RPC. The response message type (google.cloud.dataplex.v1.GenerateDataQualityRulesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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 |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest 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::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest 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::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest 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::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) 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 |