Class OsConfigServiceClient (2.18.0)

Version 2.18.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

OS Config API.

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

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

OsConfigServiceClient(OsConfigServiceClient const &)

Copy and move support

Parameter
Name	Description
	OsConfigServiceClient const &

OsConfigServiceClient(OsConfigServiceClient &&)

Copy and move support

Parameter
Name	Description
	OsConfigServiceClient &&

OsConfigServiceClient(std::shared_ptr< OsConfigServiceConnection >, Options)

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

Operators

operator=(OsConfigServiceClient const &)

Copy and move support

Parameter
Name	Description
	OsConfigServiceClient const &

Returns
Type	Description
OsConfigServiceClient &

operator=(OsConfigServiceClient &&)

Copy and move support

Parameter
Name	Description
	OsConfigServiceClient &&

Returns
Type	Description
OsConfigServiceClient &

Functions

ExecutePatchJob(google::cloud::osconfig::v1::ExecutePatchJobRequest const &, Options)

Patch VM instances by creating and running a patch job.

Parameters
Name	Description
request	google::cloud::osconfig::v1::ExecutePatchJobRequest 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.osconfig.v1.ExecutePatchJobRequest. 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::osconfig::v1::PatchJob >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPatchJob(std::string const &, Options)

Get the patch job.

This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters
Name	Description
name	std::string const & Required. Name of the patch in the form projects/*/patchJobs/*
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchJob >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPatchJob(google::cloud::osconfig::v1::GetPatchJobRequest const &, Options)

Get the patch job.

This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters
Name	Description
request	google::cloud::osconfig::v1::GetPatchJobRequest 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.osconfig.v1.GetPatchJobRequest. 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::osconfig::v1::PatchJob >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CancelPatchJob(google::cloud::osconfig::v1::CancelPatchJobRequest const &, Options)

Cancel a patch job.

The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters
Name	Description
request	google::cloud::osconfig::v1::CancelPatchJobRequest 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.osconfig.v1.CancelPatchJobRequest. 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::osconfig::v1::PatchJob >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListPatchJobs(std::string const &, Options)

Get a list of patch jobs.

Parameters
Name	Description
parent	std::string const & Required. In the form of projects/*
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::osconfig::v1::PatchJob >	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.osconfig.v1.PatchJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPatchJobs(google::cloud::osconfig::v1::ListPatchJobsRequest, Options)

Get a list of patch jobs.

Parameters
Name	Description
request	google::cloud::osconfig::v1::ListPatchJobsRequest 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.osconfig.v1.ListPatchJobsRequest. 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::osconfig::v1::PatchJob >	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.osconfig.v1.PatchJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPatchJobInstanceDetails(std::string const &, Options)

Get a list of instance details for a given patch job.

Parameters
Name	Description
parent	std::string const & Required. The parent for the instances are in the form of projects/*/patchJobs/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::osconfig::v1::PatchJobInstanceDetails >	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.osconfig.v1.PatchJobInstanceDetails, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPatchJobInstanceDetails(google::cloud::osconfig::v1::ListPatchJobInstanceDetailsRequest, Options)

Get a list of instance details for a given patch job.

Parameters
Name	Description
request	google::cloud::osconfig::v1::ListPatchJobInstanceDetailsRequest 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.osconfig.v1.ListPatchJobInstanceDetailsRequest. 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::osconfig::v1::PatchJobInstanceDetails >	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.osconfig.v1.PatchJobInstanceDetails, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreatePatchDeployment(std::string const &, google::cloud::osconfig::v1::PatchDeployment const &, std::string const &, Options)

Create an OS Config patch deployment.

Parameters
Name	Description
parent	std::string const & Required. The project to apply this patch deployment to in the form projects/*.
patch_deployment	google::cloud::osconfig::v1::PatchDeployment const & Required. The patch deployment to create.
patch_deployment_id	std::string const & Required. A name for the patch deployment in the project. When creating a name the following rules apply: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the project.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreatePatchDeployment(google::cloud::osconfig::v1::CreatePatchDeploymentRequest const &, Options)

Create an OS Config patch deployment.

Parameters
Name	Description
request	google::cloud::osconfig::v1::CreatePatchDeploymentRequest 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.osconfig.v1.CreatePatchDeploymentRequest. 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::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPatchDeployment(std::string const &, Options)

Get an OS Config patch deployment.

Parameters
Name	Description
name	std::string const & Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPatchDeployment(google::cloud::osconfig::v1::GetPatchDeploymentRequest const &, Options)

Get an OS Config patch deployment.

Parameters
Name	Description
request	google::cloud::osconfig::v1::GetPatchDeploymentRequest 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.osconfig.v1.GetPatchDeploymentRequest. 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::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListPatchDeployments(std::string const &, Options)

Get a page of OS Config patch deployments.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent in the form projects/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::osconfig::v1::PatchDeployment >	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.osconfig.v1.PatchDeployment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPatchDeployments(google::cloud::osconfig::v1::ListPatchDeploymentsRequest, Options)

Get a page of OS Config patch deployments.

Parameters
Name	Description
request	google::cloud::osconfig::v1::ListPatchDeploymentsRequest 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.osconfig.v1.ListPatchDeploymentsRequest. 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::osconfig::v1::PatchDeployment >	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.osconfig.v1.PatchDeployment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeletePatchDeployment(std::string const &, Options)

Delete an OS Config patch deployment.

Parameters
Name	Description
name	std::string const & Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
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.

DeletePatchDeployment(google::cloud::osconfig::v1::DeletePatchDeploymentRequest const &, Options)

Delete an OS Config patch deployment.

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

UpdatePatchDeployment(google::cloud::osconfig::v1::PatchDeployment const &, google::protobuf::FieldMask const &, Options)

Update an OS Config patch deployment.

Parameters
Name	Description
patch_deployment	google::cloud::osconfig::v1::PatchDeployment const & Required. The patch deployment to Update.
update_mask	google::protobuf::FieldMask const & Optional. Field mask that controls which fields of the patch deployment should be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdatePatchDeployment(google::cloud::osconfig::v1::UpdatePatchDeploymentRequest const &, Options)

Update an OS Config patch deployment.

Parameters
Name	Description
request	google::cloud::osconfig::v1::UpdatePatchDeploymentRequest 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.osconfig.v1.UpdatePatchDeploymentRequest. 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::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PausePatchDeployment(std::string const &, Options)

Change state of patch deployment to "PAUSED".

Patch deployment in paused state doesn't generate patch jobs.

Parameters
Name	Description
name	std::string const & Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PausePatchDeployment(google::cloud::osconfig::v1::PausePatchDeploymentRequest const &, Options)

Change state of patch deployment to "PAUSED".

Patch deployment in paused state doesn't generate patch jobs.

Parameters
Name	Description
request	google::cloud::osconfig::v1::PausePatchDeploymentRequest 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.osconfig.v1.PausePatchDeploymentRequest. 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::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumePatchDeployment(std::string const &, Options)

Change state of patch deployment back to "ACTIVE".

Patch deployment in active state continues to generate patch jobs.

Parameters
Name	Description
name	std::string const & Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumePatchDeployment(google::cloud::osconfig::v1::ResumePatchDeploymentRequest const &, Options)

Change state of patch deployment back to "ACTIVE".

Patch deployment in active state continues to generate patch jobs.

Parameters
Name	Description
request	google::cloud::osconfig::v1::ResumePatchDeploymentRequest 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.osconfig.v1.ResumePatchDeploymentRequest. 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::osconfig::v1::PatchDeployment >	the result of the RPC. The response message type (google.cloud.osconfig.v1.PatchDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.