Google Cloud OS Config v1alpha API - Class OsConfigZonalServiceClientImpl (2.0.0-alpha05)

public sealed class OsConfigZonalServiceClientImpl : OsConfigZonalServiceClient

Reference documentation and code samples for the Google Cloud OS Config v1alpha API class OsConfigZonalServiceClientImpl.

OsConfigZonalService client wrapper implementation, for convenient use.

Inheritance

object > OsConfigZonalServiceClient > OsConfigZonalServiceClientImpl

Namespace

Google.Cloud.OsConfig.V1Alpha

Assembly

Google.Cloud.OsConfig.V1Alpha.dll

Remarks

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.

Constructors

OsConfigZonalServiceClientImpl(OsConfigZonalServiceClient, OsConfigZonalServiceSettings, ILogger)

public OsConfigZonalServiceClientImpl(OsConfigZonalService.OsConfigZonalServiceClient grpcClient, OsConfigZonalServiceSettings settings, ILogger logger)

Constructs a client wrapper for the OsConfigZonalService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient OsConfigZonalServiceOsConfigZonalServiceClient

The underlying gRPC client.
settings OsConfigZonalServiceSettings

The base OsConfigZonalServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateOSPolicyAssignmentOperationsClient

public override OperationsClient CreateOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for CreateOSPolicyAssignment.

Property Value
Type Description
OperationsClient
Overrides

DeleteOSPolicyAssignmentOperationsClient

public override OperationsClient DeleteOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for DeleteOSPolicyAssignment.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override OsConfigZonalService.OsConfigZonalServiceClient GrpcClient { get; }

The underlying gRPC OsConfigZonalService client

Property Value
Type Description
OsConfigZonalServiceOsConfigZonalServiceClient
Overrides

UpdateOSPolicyAssignmentOperationsClient

public override OperationsClient UpdateOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for UpdateOSPolicyAssignment.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateOSPolicyAssignment(CreateOSPolicyAssignmentRequest, CallSettings)

public override Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata> CreateOSPolicyAssignment(CreateOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 CreateOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOSPolicyAssignmentOSPolicyAssignmentOperationMetadata

The RPC response.
Overrides

CreateOSPolicyAssignmentAsync(CreateOSPolicyAssignmentRequest, CallSettings)

public override Task<Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>> CreateOSPolicyAssignmentAsync(CreateOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 CreateOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOSPolicyAssignmentOSPolicyAssignmentOperationMetadata

A Task containing the RPC response.
Overrides

DeleteOSPolicyAssignment(DeleteOSPolicyAssignmentRequest, CallSettings)

public override Operation<Empty, OSPolicyAssignmentOperationMetadata> DeleteOSPolicyAssignment(DeleteOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 DeleteOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOSPolicyAssignmentOperationMetadata

The RPC response.
Overrides

DeleteOSPolicyAssignmentAsync(DeleteOSPolicyAssignmentRequest, CallSettings)

public override Task<Operation<Empty, OSPolicyAssignmentOperationMetadata>> DeleteOSPolicyAssignmentAsync(DeleteOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 DeleteOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOSPolicyAssignmentOperationMetadata

A Task containing the RPC response.
Overrides

GetInstanceOSPoliciesCompliance(GetInstanceOSPoliciesComplianceRequest, CallSettings)

[Obsolete]
public override InstanceOSPoliciesCompliance GetInstanceOSPoliciesCompliance(GetInstanceOSPoliciesComplianceRequest request, CallSettings callSettings = null)

Get OS policies compliance data for the specified Compute Engine VM instance.

Parameters
Name Description
request GetInstanceOSPoliciesComplianceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
InstanceOSPoliciesCompliance

The RPC response.
Overrides

GetInstanceOSPoliciesComplianceAsync(GetInstanceOSPoliciesComplianceRequest, CallSettings)

[Obsolete]
public override Task<InstanceOSPoliciesCompliance> GetInstanceOSPoliciesComplianceAsync(GetInstanceOSPoliciesComplianceRequest request, CallSettings callSettings = null)

Get OS policies compliance data for the specified Compute Engine VM instance.

Parameters
Name Description
request GetInstanceOSPoliciesComplianceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInstanceOSPoliciesCompliance

A Task containing the RPC response.
Overrides

GetInventory(GetInventoryRequest, CallSettings)

public override Inventory GetInventory(GetInventoryRequest request, CallSettings callSettings = null)

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 GetInventoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Inventory

The RPC response.
Overrides

GetInventoryAsync(GetInventoryRequest, CallSettings)

public override Task<Inventory> GetInventoryAsync(GetInventoryRequest request, CallSettings callSettings = null)

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 GetInventoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInventory

A Task containing the RPC response.
Overrides

GetOSPolicyAssignment(GetOSPolicyAssignmentRequest, CallSettings)

public override OSPolicyAssignment GetOSPolicyAssignment(GetOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 GetOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OSPolicyAssignment

The RPC response.
Overrides

GetOSPolicyAssignmentAsync(GetOSPolicyAssignmentRequest, CallSettings)

public override Task<OSPolicyAssignment> GetOSPolicyAssignmentAsync(GetOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 GetOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOSPolicyAssignment

A Task containing the RPC response.
Overrides

GetOSPolicyAssignmentReport(GetOSPolicyAssignmentReportRequest, CallSettings)

public override OSPolicyAssignmentReport GetOSPolicyAssignmentReport(GetOSPolicyAssignmentReportRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetOSPolicyAssignmentReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OSPolicyAssignmentReport

The RPC response.
Overrides

GetOSPolicyAssignmentReportAsync(GetOSPolicyAssignmentReportRequest, CallSettings)

public override Task<OSPolicyAssignmentReport> GetOSPolicyAssignmentReportAsync(GetOSPolicyAssignmentReportRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetOSPolicyAssignmentReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOSPolicyAssignmentReport

A Task containing the RPC response.
Overrides

GetVulnerabilityReport(GetVulnerabilityReportRequest, CallSettings)

public override VulnerabilityReport GetVulnerabilityReport(GetVulnerabilityReportRequest request, CallSettings callSettings = null)

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters
Name Description
request GetVulnerabilityReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
VulnerabilityReport

The RPC response.
Overrides

GetVulnerabilityReportAsync(GetVulnerabilityReportRequest, CallSettings)

public override Task<VulnerabilityReport> GetVulnerabilityReportAsync(GetVulnerabilityReportRequest request, CallSettings callSettings = null)

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters
Name Description
request GetVulnerabilityReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskVulnerabilityReport

A Task containing the RPC response.
Overrides

ListInstanceOSPoliciesCompliances(ListInstanceOSPoliciesCompliancesRequest, CallSettings)

[Obsolete]
public override PagedEnumerable<ListInstanceOSPoliciesCompliancesResponse, InstanceOSPoliciesCompliance> ListInstanceOSPoliciesCompliances(ListInstanceOSPoliciesCompliancesRequest request, CallSettings callSettings = null)

List OS policies compliance data for all Compute Engine VM instances in the specified zone.

Parameters
Name Description
request ListInstanceOSPoliciesCompliancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListInstanceOSPoliciesCompliancesResponseInstanceOSPoliciesCompliance

A pageable sequence of InstanceOSPoliciesCompliance resources.
Overrides

ListInstanceOSPoliciesCompliancesAsync(ListInstanceOSPoliciesCompliancesRequest, CallSettings)

[Obsolete]
public override PagedAsyncEnumerable<ListInstanceOSPoliciesCompliancesResponse, InstanceOSPoliciesCompliance> ListInstanceOSPoliciesCompliancesAsync(ListInstanceOSPoliciesCompliancesRequest request, CallSettings callSettings = null)

List OS policies compliance data for all Compute Engine VM instances in the specified zone.

Parameters
Name Description
request ListInstanceOSPoliciesCompliancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListInstanceOSPoliciesCompliancesResponseInstanceOSPoliciesCompliance

A pageable asynchronous sequence of InstanceOSPoliciesCompliance resources.
Overrides

ListInventories(ListInventoriesRequest, CallSettings)

public override PagedEnumerable<ListInventoriesResponse, Inventory> ListInventories(ListInventoriesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListInventoriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListInventoriesResponseInventory

A pageable sequence of Inventory resources.
Overrides

ListInventoriesAsync(ListInventoriesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInventoriesResponse, Inventory> ListInventoriesAsync(ListInventoriesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListInventoriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListInventoriesResponseInventory

A pageable asynchronous sequence of Inventory resources.
Overrides

ListOSPolicyAssignmentReports(ListOSPolicyAssignmentReportsRequest, CallSettings)

public override PagedEnumerable<ListOSPolicyAssignmentReportsResponse, OSPolicyAssignmentReport> ListOSPolicyAssignmentReports(ListOSPolicyAssignmentReportsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOSPolicyAssignmentReportsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOSPolicyAssignmentReportsResponseOSPolicyAssignmentReport

A pageable sequence of OSPolicyAssignmentReport resources.
Overrides

ListOSPolicyAssignmentReportsAsync(ListOSPolicyAssignmentReportsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOSPolicyAssignmentReportsResponse, OSPolicyAssignmentReport> ListOSPolicyAssignmentReportsAsync(ListOSPolicyAssignmentReportsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOSPolicyAssignmentReportsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOSPolicyAssignmentReportsResponseOSPolicyAssignmentReport

A pageable asynchronous sequence of OSPolicyAssignmentReport resources.
Overrides

ListOSPolicyAssignmentRevisions(ListOSPolicyAssignmentRevisionsRequest, CallSettings)

public override PagedEnumerable<ListOSPolicyAssignmentRevisionsResponse, OSPolicyAssignment> ListOSPolicyAssignmentRevisions(ListOSPolicyAssignmentRevisionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOSPolicyAssignmentRevisionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOSPolicyAssignmentRevisionsResponseOSPolicyAssignment

A pageable sequence of OSPolicyAssignment resources.
Overrides

ListOSPolicyAssignmentRevisionsAsync(ListOSPolicyAssignmentRevisionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOSPolicyAssignmentRevisionsResponse, OSPolicyAssignment> ListOSPolicyAssignmentRevisionsAsync(ListOSPolicyAssignmentRevisionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOSPolicyAssignmentRevisionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOSPolicyAssignmentRevisionsResponseOSPolicyAssignment

A pageable asynchronous sequence of OSPolicyAssignment resources.
Overrides

ListOSPolicyAssignments(ListOSPolicyAssignmentsRequest, CallSettings)

public override PagedEnumerable<ListOSPolicyAssignmentsResponse, OSPolicyAssignment> ListOSPolicyAssignments(ListOSPolicyAssignmentsRequest request, CallSettings callSettings = null)

List the OS policy assignments under the parent resource.

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

Parameters
Name Description
request ListOSPolicyAssignmentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOSPolicyAssignmentsResponseOSPolicyAssignment

A pageable sequence of OSPolicyAssignment resources.
Overrides

ListOSPolicyAssignmentsAsync(ListOSPolicyAssignmentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOSPolicyAssignmentsResponse, OSPolicyAssignment> ListOSPolicyAssignmentsAsync(ListOSPolicyAssignmentsRequest request, CallSettings callSettings = null)

List the OS policy assignments under the parent resource.

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

Parameters
Name Description
request ListOSPolicyAssignmentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOSPolicyAssignmentsResponseOSPolicyAssignment

A pageable asynchronous sequence of OSPolicyAssignment resources.
Overrides

ListVulnerabilityReports(ListVulnerabilityReportsRequest, CallSettings)

public override PagedEnumerable<ListVulnerabilityReportsResponse, VulnerabilityReport> ListVulnerabilityReports(ListVulnerabilityReportsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListVulnerabilityReportsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListVulnerabilityReportsResponseVulnerabilityReport

A pageable sequence of VulnerabilityReport resources.
Overrides

ListVulnerabilityReportsAsync(ListVulnerabilityReportsRequest, CallSettings)

public override PagedAsyncEnumerable<ListVulnerabilityReportsResponse, VulnerabilityReport> ListVulnerabilityReportsAsync(ListVulnerabilityReportsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListVulnerabilityReportsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListVulnerabilityReportsResponseVulnerabilityReport

A pageable asynchronous sequence of VulnerabilityReport resources.
Overrides

UpdateOSPolicyAssignment(UpdateOSPolicyAssignmentRequest, CallSettings)

public override Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata> UpdateOSPolicyAssignment(UpdateOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 UpdateOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOSPolicyAssignmentOSPolicyAssignmentOperationMetadata

The RPC response.
Overrides

UpdateOSPolicyAssignmentAsync(UpdateOSPolicyAssignmentRequest, CallSettings)

public override Task<Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>> UpdateOSPolicyAssignmentAsync(UpdateOSPolicyAssignmentRequest request, CallSettings callSettings = null)

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 UpdateOSPolicyAssignmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOSPolicyAssignmentOSPolicyAssignmentOperationMetadata

A Task containing the RPC response.
Overrides