Class OsConfigZonalServiceClient (2.34.0-rc)

Zonal OS Config API.

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM 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

OsConfigZonalServiceClient(OsConfigZonalServiceClient const &)

Copy and move support

Parameter
Name	Description
	`OsConfigZonalServiceClient const &`

OsConfigZonalServiceClient(OsConfigZonalServiceClient &&)

Copy and move support

Parameter
Name	Description
	`OsConfigZonalServiceClient &&`

OsConfigZonalServiceClient(std::shared_ptr< OsConfigZonalServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< OsConfigZonalServiceConnection >`
`opts`	`Options`

Operators

operator=(OsConfigZonalServiceClient const &)

Copy and move support

Parameter
Name	Description
	`OsConfigZonalServiceClient const &`

Returns
Type	Description
`OsConfigZonalServiceClient &`

operator=(OsConfigZonalServiceClient &&)

Copy and move support

Parameter
Name	Description
	`OsConfigZonalServiceClient &&`

Returns
Type	Description
`OsConfigZonalServiceClient &`

Functions

CreateOSPolicyAssignment(std::string const &, google::cloud::osconfig::v1::OSPolicyAssignment const &, std::string const &, Options)

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource name in the form: projects/{project}/locations/{location}
`os_policy_assignment`	`google::cloud::osconfig::v1::OSPolicyAssignment const &` Required. The OS policy assignment to be created.
`os_policy_assignment_id`	`std::string const &` Required. The logical name of the OS policy assignment in the project with the following restrictions: 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

future< StatusOr< google::cloud::osconfig::v1::OSPolicyAssignment > >

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

CreateOSPolicyAssignment(NoAwaitTag, std::string const &, google::cloud::osconfig::v1::OSPolicyAssignment const &, std::string const &, Options)

Create an OS policy assignment.

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 &`
`os_policy_assignment`	`google::cloud::osconfig::v1::OSPolicyAssignment const &`
`os_policy_assignment_id`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateOSPolicyAssignment(google::cloud::osconfig::v1::CreateOSPolicyAssignmentRequest const &, Options)

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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

CreateOSPolicyAssignment(NoAwaitTag, google::cloud::osconfig::v1::CreateOSPolicyAssignmentRequest const &, Options)

Create an OS policy assignment.

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::osconfig::v1::CreateOSPolicyAssignmentRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Create an OS policy assignment.

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::osconfig::v1::OSPolicyAssignment > >`

UpdateOSPolicyAssignment(google::cloud::osconfig::v1::OSPolicyAssignment const &, google::protobuf::FieldMask const &, Options)

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
Name	Description
`os_policy_assignment`	`google::cloud::osconfig::v1::OSPolicyAssignment const &` Required. The updated OS policy assignment.
`update_mask`	`google::protobuf::FieldMask const &` Optional. Field mask that controls which fields of the assignment should be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::osconfig::v1::OSPolicyAssignment > >

UpdateOSPolicyAssignment(NoAwaitTag, google::cloud::osconfig::v1::OSPolicyAssignment const &, google::protobuf::FieldMask const &, Options)

Update an existing OS policy assignment.

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`
`os_policy_assignment`	`google::cloud::osconfig::v1::OSPolicyAssignment const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateOSPolicyAssignment(google::cloud::osconfig::v1::UpdateOSPolicyAssignmentRequest const &, Options)

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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

UpdateOSPolicyAssignment(NoAwaitTag, google::cloud::osconfig::v1::UpdateOSPolicyAssignmentRequest const &, Options)

Update an existing OS policy assignment.

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::osconfig::v1::UpdateOSPolicyAssignmentRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Update an existing OS policy assignment.

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::osconfig::v1::OSPolicyAssignment > >`

GetOSPolicyAssignment(std::string const &, Options)

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetOSPolicyAssignment(google::cloud::osconfig::v1::GetOSPolicyAssignmentRequest const &, Options)

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

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

ListOSPolicyAssignments(std::string const &, Options)

List the OS policy assignments under the parent resource.

For each OS policy assignment, the latest revision is returned.

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

Returns

Type Description

StreamRange< google::cloud::osconfig::v1::OSPolicyAssignment >

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

ListOSPolicyAssignments(google::cloud::osconfig::v1::ListOSPolicyAssignmentsRequest, Options)

List the OS policy assignments under the parent resource.

For each OS policy assignment, the latest revision is returned.

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

ListOSPolicyAssignmentRevisions(std::string const &, Options)

List the OS policy assignment revisions for a given OS policy assignment.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the OS policy assignment to list revisions for.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::osconfig::v1::OSPolicyAssignment >

ListOSPolicyAssignmentRevisions(google::cloud::osconfig::v1::ListOSPolicyAssignmentRevisionsRequest, Options)

List the OS policy assignment revisions for a given OS policy assignment.

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

DeleteOSPolicyAssignment(std::string const &, Options)

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the OS policy assignment to be deleted
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::osconfig::v1::OSPolicyAssignmentOperationMetadata > >

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

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

Delete the OS policy assignment.

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 >`

DeleteOSPolicyAssignment(google::cloud::osconfig::v1::DeleteOSPolicyAssignmentRequest const &, Options)

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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

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

DeleteOSPolicyAssignment(NoAwaitTag, google::cloud::osconfig::v1::DeleteOSPolicyAssignmentRequest const &, Options)

Delete the OS policy assignment.

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::osconfig::v1::DeleteOSPolicyAssignmentRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Delete the OS policy assignment.

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::osconfig::v1::OSPolicyAssignmentOperationMetadata > >`

GetOSPolicyAssignmentReport(std::string const &, Options)

Get the OS policy asssignment report for the specified Compute Engine VM instance.

Parameters
Name	Description
`name`	`std::string const &` Required. API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For `{assignment_id}`, the OSPolicyAssignment id must be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetOSPolicyAssignmentReport(google::cloud::osconfig::v1::GetOSPolicyAssignmentReportRequest const &, Options)

Get the OS policy asssignment report for the specified Compute Engine VM instance.

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

ListOSPolicyAssignmentReports(std::string const &, Options)

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either `instance-name`, `instance-id`, or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For `{assignment}`, either `assignment-id` or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be `-`. For example: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports` returns all reports for the instance `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports` returns all the reports for the given assignment across all instances. `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports` returns all the reports for all assignments across all instances.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::osconfig::v1::OSPolicyAssignmentReport >

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

ListOSPolicyAssignmentReports(google::cloud::osconfig::v1::ListOSPolicyAssignmentReportsRequest, Options)

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

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

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

GetInventory(std::string const &, Options)

Get inventory data for the specified VM instance.

If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters
Name	Description
`name`	`std::string const &` Required. API resource name for inventory resource. Format: `projects/{project}/locations/{location}/instances/{instance}/inventory` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetInventory(google::cloud::osconfig::v1::GetInventoryRequest const &, Options)

Get inventory data for the specified VM instance.

If the VM has no associated inventory, the message NOT_FOUND is returned.

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

ListInventories(std::string const &, Options)

List inventory data for all VM instances in the specified zone.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::osconfig::v1::Inventory >

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

ListInventories(google::cloud::osconfig::v1::ListInventoriesRequest, Options)

List inventory data for all VM instances in the specified zone.

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

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

GetVulnerabilityReport(std::string const &, Options)

Gets the vulnerability report for the specified VM instance.

Only VMs with inventory data have vulnerability reports associated with them.

Parameters
Name	Description
`name`	`std::string const &` Required. API resource name for vulnerability resource. Format: `projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetVulnerabilityReport(google::cloud::osconfig::v1::GetVulnerabilityReportRequest const &, Options)

Gets the vulnerability report for the specified VM instance.

Only VMs with inventory data have vulnerability reports associated with them.

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

ListVulnerabilityReports(std::string const &, Options)

List vulnerability reports for all VM instances in the specified zone.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::osconfig::v1::VulnerabilityReport >

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

ListVulnerabilityReports(google::cloud::osconfig::v1::ListVulnerabilityReportsRequest, Options)

List vulnerability reports for all VM instances in the specified zone.

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

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