Class ConfigDeliveryClient (2.42.0-rc)

ConfigDelivery service manages the deployment of kubernetes configuration to a fleet of kubernetes clusters.

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

ConfigDeliveryClient(ConfigDeliveryClient const &)

Copy and move support

Parameter
Name Description
ConfigDeliveryClient const &

ConfigDeliveryClient(ConfigDeliveryClient &&)

Copy and move support

Parameter
Name Description
ConfigDeliveryClient &&

ConfigDeliveryClient(std::shared_ptr< ConfigDeliveryConnection >, Options)

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

Operators

operator=(ConfigDeliveryClient const &)

Copy and move support

Parameter
Name Description
ConfigDeliveryClient const &
Returns
Type Description
ConfigDeliveryClient &

operator=(ConfigDeliveryClient &&)

Copy and move support

Parameter
Name Description
ConfigDeliveryClient &&
Returns
Type Description
ConfigDeliveryClient &

Functions

ListResourceBundles(std::string const &, Options)

Lists ResourceBundles in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListResourceBundlesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::configdelivery::v1::ResourceBundle >

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

ListResourceBundles(google::cloud::configdelivery::v1::ListResourceBundlesRequest, Options)

Lists ResourceBundles in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::ListResourceBundlesRequest

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.configdelivery.v1.ListResourceBundlesRequest. 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::configdelivery::v1::ResourceBundle >

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

GetResourceBundle(std::string const &, Options)

Gets details of a single ResourceBundle.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::configdelivery::v1::ResourceBundle >

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

GetResourceBundle(google::cloud::configdelivery::v1::GetResourceBundleRequest const &, Options)

Gets details of a single ResourceBundle.

Parameters
Name Description
request google::cloud::configdelivery::v1::GetResourceBundleRequest 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.configdelivery.v1.GetResourceBundleRequest. 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::configdelivery::v1::ResourceBundle >

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

CreateResourceBundle(std::string const &, google::cloud::configdelivery::v1::ResourceBundle const &, std::string const &, Options)

Creates a new ResourceBundle in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

resource_bundle google::cloud::configdelivery::v1::ResourceBundle const &

Required. The resource being created

resource_bundle_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and resource_bundle_id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::ResourceBundle > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.ResourceBundle proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateResourceBundle(NoAwaitTag, std::string const &, google::cloud::configdelivery::v1::ResourceBundle const &, std::string const &, Options)

Creates a new ResourceBundle in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
resource_bundle google::cloud::configdelivery::v1::ResourceBundle const &
resource_bundle_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateResourceBundle(google::cloud::configdelivery::v1::CreateResourceBundleRequest const &, Options)

Creates a new ResourceBundle in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::CreateResourceBundleRequest 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.configdelivery.v1.CreateResourceBundleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::ResourceBundle > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.ResourceBundle proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateResourceBundle(NoAwaitTag, google::cloud::configdelivery::v1::CreateResourceBundleRequest const &, Options)

Creates a new ResourceBundle in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::configdelivery::v1::CreateResourceBundleRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new ResourceBundle in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::ResourceBundle > >

UpdateResourceBundle(google::cloud::configdelivery::v1::ResourceBundle const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ResourceBundle.

Parameters
Name Description
resource_bundle google::cloud::configdelivery::v1::ResourceBundle const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ResourceBundle resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::ResourceBundle > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.ResourceBundle proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateResourceBundle(NoAwaitTag, google::cloud::configdelivery::v1::ResourceBundle const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ResourceBundle.

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
resource_bundle google::cloud::configdelivery::v1::ResourceBundle const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateResourceBundle(google::cloud::configdelivery::v1::UpdateResourceBundleRequest const &, Options)

Updates the parameters of a single ResourceBundle.

Parameters
Name Description
request google::cloud::configdelivery::v1::UpdateResourceBundleRequest 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.configdelivery.v1.UpdateResourceBundleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::ResourceBundle > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.ResourceBundle proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateResourceBundle(NoAwaitTag, google::cloud::configdelivery::v1::UpdateResourceBundleRequest const &, Options)

Updates the parameters of a single ResourceBundle.

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

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

Updates the parameters of a single ResourceBundle.

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::configdelivery::v1::ResourceBundle > >

DeleteResourceBundle(std::string const &, Options)

Deletes a single ResourceBundle.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single ResourceBundle.

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 >

DeleteResourceBundle(google::cloud::configdelivery::v1::DeleteResourceBundleRequest const &, Options)

Deletes a single ResourceBundle.

Parameters
Name Description
request google::cloud::configdelivery::v1::DeleteResourceBundleRequest 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.configdelivery.v1.DeleteResourceBundleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteResourceBundle(NoAwaitTag, google::cloud::configdelivery::v1::DeleteResourceBundleRequest const &, Options)

Deletes a single ResourceBundle.

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

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

Deletes a single ResourceBundle.

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

ListFleetPackages(std::string const &, Options)

Lists FleetPackages in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListFleetPackagesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::configdelivery::v1::FleetPackage >

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

ListFleetPackages(google::cloud::configdelivery::v1::ListFleetPackagesRequest, Options)

Lists FleetPackages in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::ListFleetPackagesRequest

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.configdelivery.v1.ListFleetPackagesRequest. 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::configdelivery::v1::FleetPackage >

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

GetFleetPackage(std::string const &, Options)

Gets details of a single FleetPackage.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::configdelivery::v1::FleetPackage >

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

GetFleetPackage(google::cloud::configdelivery::v1::GetFleetPackageRequest const &, Options)

Gets details of a single FleetPackage.

Parameters
Name Description
request google::cloud::configdelivery::v1::GetFleetPackageRequest 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.configdelivery.v1.GetFleetPackageRequest. 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::configdelivery::v1::FleetPackage >

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

CreateFleetPackage(std::string const &, google::cloud::configdelivery::v1::FleetPackage const &, std::string const &, Options)

Creates a new FleetPackage in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

fleet_package google::cloud::configdelivery::v1::FleetPackage const &

Required. The resource being created.

fleet_package_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and fleet_package_id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::FleetPackage > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.FleetPackage proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFleetPackage(NoAwaitTag, std::string const &, google::cloud::configdelivery::v1::FleetPackage const &, std::string const &, Options)

Creates a new FleetPackage in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
fleet_package google::cloud::configdelivery::v1::FleetPackage const &
fleet_package_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateFleetPackage(google::cloud::configdelivery::v1::CreateFleetPackageRequest const &, Options)

Creates a new FleetPackage in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::CreateFleetPackageRequest 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.configdelivery.v1.CreateFleetPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::FleetPackage > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.FleetPackage proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateFleetPackage(NoAwaitTag, google::cloud::configdelivery::v1::CreateFleetPackageRequest const &, Options)

Creates a new FleetPackage in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::configdelivery::v1::CreateFleetPackageRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new FleetPackage in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::FleetPackage > >

UpdateFleetPackage(google::cloud::configdelivery::v1::FleetPackage const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FleetPackage.

Parameters
Name Description
fleet_package google::cloud::configdelivery::v1::FleetPackage const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the FleetPackage resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::FleetPackage > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.FleetPackage proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateFleetPackage(NoAwaitTag, google::cloud::configdelivery::v1::FleetPackage const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single FleetPackage.

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
fleet_package google::cloud::configdelivery::v1::FleetPackage const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateFleetPackage(google::cloud::configdelivery::v1::UpdateFleetPackageRequest const &, Options)

Updates the parameters of a single FleetPackage.

Parameters
Name Description
request google::cloud::configdelivery::v1::UpdateFleetPackageRequest 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.configdelivery.v1.UpdateFleetPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::FleetPackage > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.FleetPackage proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateFleetPackage(NoAwaitTag, google::cloud::configdelivery::v1::UpdateFleetPackageRequest const &, Options)

Updates the parameters of a single FleetPackage.

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

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

Updates the parameters of a single FleetPackage.

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::configdelivery::v1::FleetPackage > >

DeleteFleetPackage(std::string const &, Options)

Deletes a single FleetPackage.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single FleetPackage.

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 >

DeleteFleetPackage(google::cloud::configdelivery::v1::DeleteFleetPackageRequest const &, Options)

Deletes a single FleetPackage.

Parameters
Name Description
request google::cloud::configdelivery::v1::DeleteFleetPackageRequest 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.configdelivery.v1.DeleteFleetPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteFleetPackage(NoAwaitTag, google::cloud::configdelivery::v1::DeleteFleetPackageRequest const &, Options)

Deletes a single FleetPackage.

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

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

Deletes a single FleetPackage.

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

ListReleases(std::string const &, Options)

Lists Releases in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListReleasesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::configdelivery::v1::Release >

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

ListReleases(google::cloud::configdelivery::v1::ListReleasesRequest, Options)

Lists Releases in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::ListReleasesRequest

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.configdelivery.v1.ListReleasesRequest. 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::configdelivery::v1::Release >

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

GetRelease(std::string const &, Options)

Gets details of a single Release.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::configdelivery::v1::Release >

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

GetRelease(google::cloud::configdelivery::v1::GetReleaseRequest const &, Options)

Gets details of a single Release.

Parameters
Name Description
request google::cloud::configdelivery::v1::GetReleaseRequest 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.configdelivery.v1.GetReleaseRequest. 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::configdelivery::v1::Release >

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

CreateRelease(std::string const &, google::cloud::configdelivery::v1::Release const &, std::string const &, Options)

Creates a new Release in a given project, location and resource bundle.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

release google::cloud::configdelivery::v1::Release const &

Required. The resource being created

release_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and release_id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Release > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRelease(NoAwaitTag, std::string const &, google::cloud::configdelivery::v1::Release const &, std::string const &, Options)

Creates a new Release in a given project, location and resource bundle.

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 &
release google::cloud::configdelivery::v1::Release const &
release_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRelease(google::cloud::configdelivery::v1::CreateReleaseRequest const &, Options)

Creates a new Release in a given project, location and resource bundle.

Parameters
Name Description
request google::cloud::configdelivery::v1::CreateReleaseRequest 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.configdelivery.v1.CreateReleaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Release > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRelease(NoAwaitTag, google::cloud::configdelivery::v1::CreateReleaseRequest const &, Options)

Creates a new Release in a given project, location and resource bundle.

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

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

Creates a new Release in a given project, location and resource bundle.

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::configdelivery::v1::Release > >

UpdateRelease(google::cloud::configdelivery::v1::Release const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Release.

Parameters
Name Description
release google::cloud::configdelivery::v1::Release const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Release resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Release > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRelease(NoAwaitTag, google::cloud::configdelivery::v1::Release const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Release.

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
release google::cloud::configdelivery::v1::Release const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateRelease(google::cloud::configdelivery::v1::UpdateReleaseRequest const &, Options)

Updates the parameters of a single Release.

Parameters
Name Description
request google::cloud::configdelivery::v1::UpdateReleaseRequest 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.configdelivery.v1.UpdateReleaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Release > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRelease(NoAwaitTag, google::cloud::configdelivery::v1::UpdateReleaseRequest const &, Options)

Updates the parameters of a single Release.

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

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

Updates the parameters of a single Release.

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::configdelivery::v1::Release > >

DeleteRelease(std::string const &, Options)

Deletes a single Release.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Release.

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 >

DeleteRelease(google::cloud::configdelivery::v1::DeleteReleaseRequest const &, Options)

Deletes a single Release.

Parameters
Name Description
request google::cloud::configdelivery::v1::DeleteReleaseRequest 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.configdelivery.v1.DeleteReleaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRelease(NoAwaitTag, google::cloud::configdelivery::v1::DeleteReleaseRequest const &, Options)

Deletes a single Release.

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

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

Deletes a single Release.

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

ListVariants(std::string const &, Options)

Lists Variants in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListVariantsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::configdelivery::v1::Variant >

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

ListVariants(google::cloud::configdelivery::v1::ListVariantsRequest, Options)

Lists Variants in a given project and location.

Parameters
Name Description
request google::cloud::configdelivery::v1::ListVariantsRequest

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.configdelivery.v1.ListVariantsRequest. 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::configdelivery::v1::Variant >

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

GetVariant(std::string const &, Options)

Gets details of a single Variant.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::configdelivery::v1::Variant >

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

GetVariant(google::cloud::configdelivery::v1::GetVariantRequest const &, Options)

Gets details of a single Variant.

Parameters
Name Description
request google::cloud::configdelivery::v1::GetVariantRequest 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.configdelivery.v1.GetVariantRequest. 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::configdelivery::v1::Variant >

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

CreateVariant(std::string const &, google::cloud::configdelivery::v1::Variant const &, std::string const &, Options)

Creates a new Variant in a given project, location, resource bundle, and release.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

variant google::cloud::configdelivery::v1::Variant const &

Required. The resource being created

variant_id std::string const &

Required. Id of the requesting object

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Variant > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Variant proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVariant(NoAwaitTag, std::string const &, google::cloud::configdelivery::v1::Variant const &, std::string const &, Options)

Creates a new Variant in a given project, location, resource bundle, and release.

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 &
variant google::cloud::configdelivery::v1::Variant const &
variant_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateVariant(google::cloud::configdelivery::v1::CreateVariantRequest const &, Options)

Creates a new Variant in a given project, location, resource bundle, and release.

Parameters
Name Description
request google::cloud::configdelivery::v1::CreateVariantRequest 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.configdelivery.v1.CreateVariantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Variant > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Variant proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVariant(NoAwaitTag, google::cloud::configdelivery::v1::CreateVariantRequest const &, Options)

Creates a new Variant in a given project, location, resource bundle, and release.

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

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

Creates a new Variant in a given project, location, resource bundle, and release.

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::configdelivery::v1::Variant > >

UpdateVariant(google::cloud::configdelivery::v1::Variant const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Variant.

Parameters
Name Description
variant google::cloud::configdelivery::v1::Variant const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Variant resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Variant > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Variant proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateVariant(NoAwaitTag, google::cloud::configdelivery::v1::Variant const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Variant.

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
variant google::cloud::configdelivery::v1::Variant const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateVariant(google::cloud::configdelivery::v1::UpdateVariantRequest const &, Options)

Updates the parameters of a single Variant.

Parameters
Name Description
request google::cloud::configdelivery::v1::UpdateVariantRequest 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.configdelivery.v1.UpdateVariantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Variant > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Variant proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateVariant(NoAwaitTag, google::cloud::configdelivery::v1::UpdateVariantRequest const &, Options)

Updates the parameters of a single Variant.

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

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

Updates the parameters of a single Variant.

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::configdelivery::v1::Variant > >

DeleteVariant(std::string const &, Options)

Deletes a single Variant.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Variant.

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 >

DeleteVariant(google::cloud::configdelivery::v1::DeleteVariantRequest const &, Options)

Deletes a single Variant.

Parameters
Name Description
request google::cloud::configdelivery::v1::DeleteVariantRequest 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.configdelivery.v1.DeleteVariantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVariant(NoAwaitTag, google::cloud::configdelivery::v1::DeleteVariantRequest const &, Options)

Deletes a single Variant.

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

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

Deletes a single Variant.

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

ListRollouts(std::string const &, Options)

Lists Rollouts in a given project, location, and Fleet Package.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListRolloutsRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::configdelivery::v1::Rollout >

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

ListRollouts(google::cloud::configdelivery::v1::ListRolloutsRequest, Options)

Lists Rollouts in a given project, location, and Fleet Package.

Parameters
Name Description
request google::cloud::configdelivery::v1::ListRolloutsRequest

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.configdelivery.v1.ListRolloutsRequest. 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::configdelivery::v1::Rollout >

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

GetRollout(std::string const &, Options)

Gets details of a single Rollout.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::configdelivery::v1::Rollout >

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

GetRollout(google::cloud::configdelivery::v1::GetRolloutRequest const &, Options)

Gets details of a single Rollout.

Parameters
Name Description
request google::cloud::configdelivery::v1::GetRolloutRequest 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.configdelivery.v1.GetRolloutRequest. 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::configdelivery::v1::Rollout >

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

SuspendRollout(std::string const &, Options)

Suspend a Rollout.

Parameters
Name Description
name std::string const &

Required. Name of the Rollout.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Suspend a Rollout.

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 >

SuspendRollout(google::cloud::configdelivery::v1::SuspendRolloutRequest const &, Options)

Suspend a Rollout.

Parameters
Name Description
request google::cloud::configdelivery::v1::SuspendRolloutRequest 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.configdelivery.v1.SuspendRolloutRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SuspendRollout(NoAwaitTag, google::cloud::configdelivery::v1::SuspendRolloutRequest const &, Options)

Suspend a Rollout.

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

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

Suspend a Rollout.

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::configdelivery::v1::Rollout > >

ResumeRollout(std::string const &, Options)

Resume a Rollout.

Parameters
Name Description
name std::string const &

Required. Name of the Rollout.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Resume a Rollout.

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 >

ResumeRollout(google::cloud::configdelivery::v1::ResumeRolloutRequest const &, Options)

Resume a Rollout.

Parameters
Name Description
request google::cloud::configdelivery::v1::ResumeRolloutRequest 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.configdelivery.v1.ResumeRolloutRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResumeRollout(NoAwaitTag, google::cloud::configdelivery::v1::ResumeRolloutRequest const &, Options)

Resume a Rollout.

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

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

Resume a Rollout.

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::configdelivery::v1::Rollout > >

AbortRollout(std::string const &, Options)

Abort a Rollout.

Parameters
Name Description
name std::string const &

Required. Name of the Rollout.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Abort a Rollout.

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 >

AbortRollout(google::cloud::configdelivery::v1::AbortRolloutRequest const &, Options)

Abort a Rollout.

Parameters
Name Description
request google::cloud::configdelivery::v1::AbortRolloutRequest 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.configdelivery.v1.AbortRolloutRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::configdelivery::v1::Rollout > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.configdelivery.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AbortRollout(NoAwaitTag, google::cloud::configdelivery::v1::AbortRolloutRequest const &, Options)

Abort a Rollout.

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

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

Abort a Rollout.

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::configdelivery::v1::Rollout > >

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.