Class ConfigClient (2.28.0)

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ConfigClient(ConfigClient const &)

Copy and move support

Parameter
Name Description
ConfigClient const &

ConfigClient(ConfigClient &&)

Copy and move support

Parameter
Name Description
ConfigClient &&

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

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

Operators

operator=(ConfigClient const &)

Copy and move support

Parameter
Name Description
ConfigClient const &
Returns
Type Description
ConfigClient &

operator=(ConfigClient &&)

Copy and move support

Parameter
Name Description
ConfigClient &&
Returns
Type Description
ConfigClient &

Functions

ListDeployments(std::string const &, Options)

Lists Deployments in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::config::v1::Deployment >

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

ListDeployments(google::cloud::config::v1::ListDeploymentsRequest, Options)

Lists Deployments in a given project and location.

Parameters
Name Description
request google::cloud::config::v1::ListDeploymentsRequest

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.config.v1.ListDeploymentsRequest. 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::config::v1::Deployment >

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

GetDeployment(std::string const &, Options)

Gets details about a Deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::Deployment >

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

GetDeployment(google::cloud::config::v1::GetDeploymentRequest const &, Options)

Gets details about a Deployment.

Parameters
Name Description
request google::cloud::config::v1::GetDeploymentRequest 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.config.v1.GetDeploymentRequest. 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::config::v1::Deployment >

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

CreateDeployment(std::string const &, google::cloud::config::v1::Deployment const &, std::string const &, Options)

Creates a Deployment.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deployment google::cloud::config::v1::Deployment const &

Required. Deployment resource to be created.

deployment_id std::string const &

Required. The Deployment ID.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Deployment > >

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

CreateDeployment(NoAwaitTag, std::string const &, google::cloud::config::v1::Deployment const &, std::string const &, Options)

Creates a Deployment.

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 &
deployment google::cloud::config::v1::Deployment const &
deployment_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDeployment(google::cloud::config::v1::CreateDeploymentRequest const &, Options)

Creates a Deployment.

Parameters
Name Description
request google::cloud::config::v1::CreateDeploymentRequest 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.config.v1.CreateDeploymentRequest. 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::config::v1::Deployment > >

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

CreateDeployment(NoAwaitTag, google::cloud::config::v1::CreateDeploymentRequest const &, Options)

Creates a Deployment.

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

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

Creates a Deployment.

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::config::v1::Deployment > >

UpdateDeployment(google::cloud::config::v1::Deployment const &, google::protobuf::FieldMask const &, Options)

Updates a Deployment.

Parameters
Name Description
deployment google::cloud::config::v1::Deployment const &

Required. Deployment to update.
The deployment's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deployments/{deployment}

update_mask google::protobuf::FieldMask const &

Optional. Field mask used to specify the fields to be overwritten in the Deployment 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::config::v1::Deployment > >

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

UpdateDeployment(NoAwaitTag, google::cloud::config::v1::Deployment const &, google::protobuf::FieldMask const &, Options)

Updates a Deployment.

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

UpdateDeployment(google::cloud::config::v1::UpdateDeploymentRequest const &, Options)

Updates a Deployment.

Parameters
Name Description
request google::cloud::config::v1::UpdateDeploymentRequest 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.config.v1.UpdateDeploymentRequest. 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::config::v1::Deployment > >

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

UpdateDeployment(NoAwaitTag, google::cloud::config::v1::UpdateDeploymentRequest const &, Options)

Updates a Deployment.

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

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

Updates a Deployment.

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::config::v1::Deployment > >

DeleteDeployment(std::string const &, Options)

Deletes a Deployment.

Parameters
Name Description
name std::string const &

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Deployment > >

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

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

Deletes a Deployment.

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 >

DeleteDeployment(google::cloud::config::v1::DeleteDeploymentRequest const &, Options)

Deletes a Deployment.

Parameters
Name Description
request google::cloud::config::v1::DeleteDeploymentRequest 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.config.v1.DeleteDeploymentRequest. 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::config::v1::Deployment > >

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

DeleteDeployment(NoAwaitTag, google::cloud::config::v1::DeleteDeploymentRequest const &, Options)

Deletes a Deployment.

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

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

Deletes a Deployment.

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::config::v1::Deployment > >

ListRevisions(std::string const &, Options)

Lists Revisions of a deployment.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::config::v1::Revision >

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

ListRevisions(google::cloud::config::v1::ListRevisionsRequest, Options)

Lists Revisions of a deployment.

Parameters
Name Description
request google::cloud::config::v1::ListRevisionsRequest

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.config.v1.ListRevisionsRequest. 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::config::v1::Revision >

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

GetRevision(std::string const &, Options)

Gets details about a Revision.

Parameters
Name Description
name std::string const &

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::Revision >

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

GetRevision(google::cloud::config::v1::GetRevisionRequest const &, Options)

Gets details about a Revision.

Parameters
Name Description
request google::cloud::config::v1::GetRevisionRequest 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.config.v1.GetRevisionRequest. 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::config::v1::Revision >

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

GetResource(std::string const &, Options)

Gets details about a Resource deployed by Infra Manager.

Parameters
Name Description
name std::string const &

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::Resource >

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

GetResource(google::cloud::config::v1::GetResourceRequest const &, Options)

Gets details about a Resource deployed by Infra Manager.

Parameters
Name Description
request google::cloud::config::v1::GetResourceRequest 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.config.v1.GetResourceRequest. 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::config::v1::Resource >

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

ListResources(std::string const &, Options)

Lists Resources in a given revision.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::config::v1::Resource >

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

ListResources(google::cloud::config::v1::ListResourcesRequest, Options)

Lists Resources in a given revision.

Parameters
Name Description
request google::cloud::config::v1::ListResourcesRequest

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.config.v1.ListResourcesRequest. 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::config::v1::Resource >

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

ExportDeploymentStatefile(google::cloud::config::v1::ExportDeploymentStatefileRequest const &, Options)

Exports Terraform state file from a given deployment.

Parameters
Name Description
request google::cloud::config::v1::ExportDeploymentStatefileRequest 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.config.v1.ExportDeploymentStatefileRequest. 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::config::v1::Statefile >

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

ExportRevisionStatefile(google::cloud::config::v1::ExportRevisionStatefileRequest const &, Options)

Exports Terraform state file from a given revision.

Parameters
Name Description
request google::cloud::config::v1::ExportRevisionStatefileRequest 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.config.v1.ExportRevisionStatefileRequest. 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::config::v1::Statefile >

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

ImportStatefile(std::string const &, std::int64_t, Options)

Imports Terraform state file in a given deployment.

The state file does not take effect until the Deployment has been unlocked.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lock_id std::int64_t

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::Statefile >

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

ImportStatefile(google::cloud::config::v1::ImportStatefileRequest const &, Options)

Imports Terraform state file in a given deployment.

The state file does not take effect until the Deployment has been unlocked.

Parameters
Name Description
request google::cloud::config::v1::ImportStatefileRequest 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.config.v1.ImportStatefileRequest. 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::config::v1::Statefile >

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

DeleteStatefile(std::string const &, Options)

Deletes Terraform state file in a given deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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.

DeleteStatefile(google::cloud::config::v1::DeleteStatefileRequest const &, Options)

Deletes Terraform state file in a given deployment.

Parameters
Name Description
request google::cloud::config::v1::DeleteStatefileRequest 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.config.v1.DeleteStatefileRequest. 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.

LockDeployment(std::string const &, Options)

Locks a deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Deployment > >

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

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

Locks a deployment.

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 >

LockDeployment(google::cloud::config::v1::LockDeploymentRequest const &, Options)

Locks a deployment.

Parameters
Name Description
request google::cloud::config::v1::LockDeploymentRequest 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.config.v1.LockDeploymentRequest. 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::config::v1::Deployment > >

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

LockDeployment(NoAwaitTag, google::cloud::config::v1::LockDeploymentRequest const &, Options)

Locks a deployment.

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

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

Locks a deployment.

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::config::v1::Deployment > >

UnlockDeployment(std::string const &, std::int64_t, Options)

Unlocks a locked deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lock_id std::int64_t

Required. Lock ID of the lock file to be unlocked.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Deployment > >

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

UnlockDeployment(NoAwaitTag, std::string const &, std::int64_t, Options)

Unlocks a locked deployment.

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 &
lock_id std::int64_t
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UnlockDeployment(google::cloud::config::v1::UnlockDeploymentRequest const &, Options)

Unlocks a locked deployment.

Parameters
Name Description
request google::cloud::config::v1::UnlockDeploymentRequest 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.config.v1.UnlockDeploymentRequest. 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::config::v1::Deployment > >

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

UnlockDeployment(NoAwaitTag, google::cloud::config::v1::UnlockDeploymentRequest const &, Options)

Unlocks a locked deployment.

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

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

Unlocks a locked deployment.

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::config::v1::Deployment > >

ExportLockInfo(std::string const &, Options)

Exports the lock info on a locked deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::LockInfo >

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

ExportLockInfo(google::cloud::config::v1::ExportLockInfoRequest const &, Options)

Exports the lock info on a locked deployment.

Parameters
Name Description
request google::cloud::config::v1::ExportLockInfoRequest 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.config.v1.ExportLockInfoRequest. 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::config::v1::LockInfo >

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

CreatePreview(std::string const &, google::cloud::config::v1::Preview const &, Options)

Creates a Preview.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

preview google::cloud::config::v1::Preview const &

Required. Preview resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Preview > >

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

CreatePreview(NoAwaitTag, std::string const &, google::cloud::config::v1::Preview const &, Options)

Creates a Preview.

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 &
preview google::cloud::config::v1::Preview const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePreview(google::cloud::config::v1::CreatePreviewRequest const &, Options)

Creates a Preview.

Parameters
Name Description
request google::cloud::config::v1::CreatePreviewRequest 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.config.v1.CreatePreviewRequest. 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::config::v1::Preview > >

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

CreatePreview(NoAwaitTag, google::cloud::config::v1::CreatePreviewRequest const &, Options)

Creates a Preview.

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

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

Creates a Preview.

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::config::v1::Preview > >

GetPreview(std::string const &, Options)

Gets details about a Preview.

Parameters
Name Description
name std::string const &

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::Preview >

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

GetPreview(google::cloud::config::v1::GetPreviewRequest const &, Options)

Gets details about a Preview.

Parameters
Name Description
request google::cloud::config::v1::GetPreviewRequest 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.config.v1.GetPreviewRequest. 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::config::v1::Preview >

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

ListPreviews(std::string const &, Options)

Lists Previews in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::config::v1::Preview >

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

ListPreviews(google::cloud::config::v1::ListPreviewsRequest, Options)

Lists Previews in a given project and location.

Parameters
Name Description
request google::cloud::config::v1::ListPreviewsRequest

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.config.v1.ListPreviewsRequest. 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::config::v1::Preview >

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

DeletePreview(std::string const &, Options)

Deletes a Preview.

Parameters
Name Description
name std::string const &

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::config::v1::Preview > >

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

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

Deletes a Preview.

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 >

DeletePreview(google::cloud::config::v1::DeletePreviewRequest const &, Options)

Deletes a Preview.

Parameters
Name Description
request google::cloud::config::v1::DeletePreviewRequest 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.config.v1.DeletePreviewRequest. 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::config::v1::Preview > >

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

DeletePreview(NoAwaitTag, google::cloud::config::v1::DeletePreviewRequest const &, Options)

Deletes a Preview.

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

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

Deletes a Preview.

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::config::v1::Preview > >

ExportPreviewResult(google::cloud::config::v1::ExportPreviewResultRequest const &, Options)

Export Preview results.

Parameters
Name Description
request google::cloud::config::v1::ExportPreviewResultRequest 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.config.v1.ExportPreviewResultRequest. 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::config::v1::ExportPreviewResultResponse >

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

ListTerraformVersions(std::string const &, Options)

Lists TerraformVersions in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::config::v1::TerraformVersion >

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

ListTerraformVersions(google::cloud::config::v1::ListTerraformVersionsRequest, Options)

Lists TerraformVersions in a given project and location.

Parameters
Name Description
request google::cloud::config::v1::ListTerraformVersionsRequest

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.config.v1.ListTerraformVersionsRequest. 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::config::v1::TerraformVersion >

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

GetTerraformVersion(std::string const &, Options)

Gets details about a TerraformVersion.

Parameters
Name Description
name std::string const &

Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'

opts Options

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

Returns
Type Description
StatusOr< google::cloud::config::v1::TerraformVersion >

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

GetTerraformVersion(google::cloud::config::v1::GetTerraformVersionRequest const &, Options)

Gets details about a TerraformVersion.

Parameters
Name Description
request google::cloud::config::v1::GetTerraformVersionRequest 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.config.v1.GetTerraformVersionRequest. 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::config::v1::TerraformVersion >

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