Class ConfigClient (2.45.0-rc)

Config Service manages compliance frameworks, cloud controls, and their configurations.

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

ConfigClient(ConfigClient const &)

Copy and move support

Parameter
Name Description
ConfigClient const &

ConfigClient(ConfigClient &&)

Copy and move support

Parameter
Name Description
ConfigClient &&

ConfigClient(std::shared_ptr< ConfigConnection >, Options)

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

Operators

operator=(ConfigClient const &)

Copy and move support

Parameter
Name Description
ConfigClient const &
Returns
Type Description
ConfigClient &

operator=(ConfigClient &&)

Copy and move support

Parameter
Name Description
ConfigClient &&
Returns
Type Description
ConfigClient &

Functions

ListFrameworks(std::string const &, Options)

Lists the frameworks (both built-in and custom) that are available within the parent resource.

The latest major version of each framework is returned. This method supports pagination.

Parameters
Name Description
parent std::string const &

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. The only supported location is global.

opts Options

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

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

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

ListFrameworks(google::cloud::cloudsecuritycompliance::v1::ListFrameworksRequest, Options)

Lists the frameworks (both built-in and custom) that are available within the parent resource.

The latest major version of each framework is returned. This method supports pagination.

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

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.ListFrameworksRequest. 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::Framework >

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

GetFramework(std::string const &, Options)

Gets details about a framework.

This method retrieves the latest major version of the framework.

To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
name std::string const &

Required. The name of the framework to retrieve, in the format organizations/{organization}/locations/{location}/frameworks/{framework_id} The only supported location is global.

opts Options

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

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

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

GetFramework(google::cloud::cloudsecuritycompliance::v1::GetFrameworkRequest const &, Options)

Gets details about a framework.

This method retrieves the latest major version of the framework.

To retrieve a specific major version, include major_revision_id in the request.

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

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

CreateFramework(std::string const &, google::cloud::cloudsecuritycompliance::v1::Framework const &, std::string const &, Options)

Creates a custom framework in a given parent resource.

You can't create built-in frameworks because those are managed by Google.

Parameters
Name Description
parent std::string const &

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. The only supported location is global.

framework google::cloud::cloudsecuritycompliance::v1::Framework const &

Required. The resource being created.

framework_id std::string const &

Required. The identifier (ID) of the framework. The ID is not the full name of the framework; it's the last part of the full name of the framework.

opts Options

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

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

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

CreateFramework(google::cloud::cloudsecuritycompliance::v1::CreateFrameworkRequest const &, Options)

Creates a custom framework in a given parent resource.

You can't create built-in frameworks because those are managed by Google.

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

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

UpdateFramework(google::cloud::cloudsecuritycompliance::v1::Framework const &, google::protobuf::FieldMask const &, Options)

Updates a custom framework.

This method allows for partial updates of a framework. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's framework body are used to overwrite the existing resource.

You can only update frameworks with the CUSTOM type. A successful update creates a new version of the framework.

Parameters
Name Description
framework google::cloud::cloudsecuritycompliance::v1::Framework const &

Required. The resource that is being updated.

update_mask google::protobuf::FieldMask const &

Optional. A field mask is used to specify the fields to be overwritten in the framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't provide a mask then all fields present in the request will be overwritten.

opts Options

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

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

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

UpdateFramework(google::cloud::cloudsecuritycompliance::v1::UpdateFrameworkRequest const &, Options)

Updates a custom framework.

This method allows for partial updates of a framework. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's framework body are used to overwrite the existing resource.

You can only update frameworks with the CUSTOM type. A successful update creates a new version of the framework.

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

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

DeleteFramework(std::string const &, Options)

Deletes a custom framework, including all its major and minor revisions.

Consider the following:

  • You can't delete built-in frameworks. You can only delete frameworks with type CUSTOM.
  • You can't delete frameworks that are deployed to a resource.
  • You can't restore a deleted framework. This action is permanent.
Parameters
Name Description
name std::string const &

Required. The name of the resource, in the format organizations/{organization}/locations/{location}/frameworks/{framework}. The only supported location is global.

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.

DeleteFramework(google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkRequest const &, Options)

Deletes a custom framework, including all its major and minor revisions.

Consider the following:

  • You can't delete built-in frameworks. You can only delete frameworks with type CUSTOM.
  • You can't delete frameworks that are deployed to a resource.
  • You can't restore a deleted framework. This action is permanent.
Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkRequest 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.DeleteFrameworkRequest. 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.

ListCloudControls(std::string const &, Options)

Lists the cloud controls (both built-in and custom) that are available in a given parent resource.

The latest major version of each cloud control is returned. This method supports pagination.

Parameters
Name Description
parent std::string const &

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. The only supported location is global.

opts Options

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

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

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

ListCloudControls(google::cloud::cloudsecuritycompliance::v1::ListCloudControlsRequest, Options)

Lists the cloud controls (both built-in and custom) that are available in a given parent resource.

The latest major version of each cloud control is returned. This method supports pagination.

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

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.ListCloudControlsRequest. 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::CloudControl >

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

GetCloudControl(std::string const &, Options)

Gets details about a cloud control.

This method retrieves the latest major version of a cloud control that you identify by name.

By default, the latest major version of the cloud control is returned. To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
name std::string const &

Required. The name of the cloud control to retrieve, in the format organizations/{organization}/locations/{location}/cloudControls/{cloud_control}. The only supported location is global.

opts Options

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

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

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

GetCloudControl(google::cloud::cloudsecuritycompliance::v1::GetCloudControlRequest const &, Options)

Gets details about a cloud control.

This method retrieves the latest major version of a cloud control that you identify by name.

By default, the latest major version of the cloud control is returned. To retrieve a specific major version, include major_revision_id in the request.

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

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

CreateCloudControl(std::string const &, google::cloud::cloudsecuritycompliance::v1::CloudControl const &, std::string const &, Options)

Creates a custom cloud control in a given parent resource.

You can't create built-in cloud controls because those are managed by Google.

Parameters
Name Description
parent std::string const &

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. The only supported location is global.

cloud_control google::cloud::cloudsecuritycompliance::v1::CloudControl const &

Required. The cloud control that's being created.

cloud_control_id std::string const &

Required. The identifier for the cloud control, which is the last segment of the cloud control name. The format is ^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$.

opts Options

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

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

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

CreateCloudControl(google::cloud::cloudsecuritycompliance::v1::CreateCloudControlRequest const &, Options)

Creates a custom cloud control in a given parent resource.

You can't create built-in cloud controls because those are managed by Google.

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

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

UpdateCloudControl(google::cloud::cloudsecuritycompliance::v1::CloudControl const &, google::protobuf::FieldMask const &, Options)

Updates a custom cloud control.

This method allows for partial updates of a cloud control. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's cloud_control body are used to overwrite the existing resource.

You can only update cloud controls with the CUSTOM type. A successful update creates a new version of the cloud control.

Parameters
Name Description
cloud_control google::cloud::cloudsecuritycompliance::v1::CloudControl const &

Required. The cloud control that you're updating.

update_mask google::protobuf::FieldMask const &

Optional. Use a field mask to specify the fields to be overwritten in the cloud control during the update. The fields that you specify in the update_mask are relative to the cloud control, not the full request. A field is overwritten if it is in the mask. If you don't provide a mask, all fields in the request are updated.
You can update the following fields:

  • Display name
  • Description
  • Parameters
  • Rules
  • Parameter specification
opts Options

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

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

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

UpdateCloudControl(google::cloud::cloudsecuritycompliance::v1::UpdateCloudControlRequest const &, Options)

Updates a custom cloud control.

This method allows for partial updates of a cloud control. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's cloud_control body are used to overwrite the existing resource.

You can only update cloud controls with the CUSTOM type. A successful update creates a new version of the cloud control.

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

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

DeleteCloudControl(std::string const &, Options)

Deletes a custom cloud control, including all its major and minor revisions.

Consider the following:

  • You can't delete built-in cloud controls. You can only delete cloud controls with type CUSTOM.
  • You can't delete cloud controls if any of the versions are referenced by a framework.
  • You can't restore a deleted cloud control. This action is permanent.
Parameters
Name Description
name std::string const &

Required. The name of the cloud control to delete, in the format organizations/{organization}/locations/{location}/CloudControls/{CloudControl}. The only supported location is global.

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.

DeleteCloudControl(google::cloud::cloudsecuritycompliance::v1::DeleteCloudControlRequest const &, Options)

Deletes a custom cloud control, including all its major and minor revisions.

Consider the following:

  • You can't delete built-in cloud controls. You can only delete cloud controls with type CUSTOM.
  • You can't delete cloud controls if any of the versions are referenced by a framework.
  • You can't restore a deleted cloud control. This action is permanent.
Parameters
Name Description
request google::cloud::cloudsecuritycompliance::v1::DeleteCloudControlRequest 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.DeleteCloudControlRequest. 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.

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.