Class OsConfigZonalServiceClientImpl (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class OsConfigZonalServiceClientImpl : OsConfigZonalServiceClient

OsConfigZonalService client wrapper implementation, for convenient use.

Inheritance

Object > OsConfigZonalServiceClient > OsConfigZonalServiceClientImpl

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.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(OsConfigZonalService.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
NameDescription
grpcClientOsConfigZonalService.OsConfigZonalServiceClient

The underlying gRPC client.

settingsOsConfigZonalServiceSettings

The base OsConfigZonalServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateOSPolicyAssignmentOperationsClient

public override OperationsClient CreateOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for CreateOSPolicyAssignment.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteOSPolicyAssignmentOperationsClient

public override OperationsClient DeleteOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for DeleteOSPolicyAssignment.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override OsConfigZonalService.OsConfigZonalServiceClient GrpcClient { get; }

The underlying gRPC OsConfigZonalService client

Property Value
TypeDescription
OsConfigZonalService.OsConfigZonalServiceClient
Overrides

UpdateOSPolicyAssignmentOperationsClient

public override OperationsClient UpdateOSPolicyAssignmentOperationsClient { get; }

The long-running operations client for UpdateOSPolicyAssignment.

Property Value
TypeDescription
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
NameDescription
requestCreateOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>

The RPC response.

Overrides

CreateOSPolicyAssignmentAsync(CreateOSPolicyAssignmentRequest, CallSettings)

public override async 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
NameDescription
requestCreateOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>>

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
NameDescription
requestDeleteOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OSPolicyAssignmentOperationMetadata>

The RPC response.

Overrides

DeleteOSPolicyAssignmentAsync(DeleteOSPolicyAssignmentRequest, CallSettings)

public override async 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
NameDescription
requestDeleteOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OSPolicyAssignmentOperationMetadata>>

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
NameDescription
requestGetInventoryRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetInventoryRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Inventory>

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
NameDescription
requestGetOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<OSPolicyAssignment>

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
NameDescription
requestGetOSPolicyAssignmentReportRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetOSPolicyAssignmentReportRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<OSPolicyAssignmentReport>

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
NameDescription
requestGetVulnerabilityReportRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetVulnerabilityReportRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<VulnerabilityReport>

A Task containing the RPC response.

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
NameDescription
requestListInventoriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListInventoriesResponse, Inventory>

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
NameDescription
requestListInventoriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListInventoriesResponse, Inventory>

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
NameDescription
requestListOSPolicyAssignmentReportsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListOSPolicyAssignmentReportsResponse, OSPolicyAssignmentReport>

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
NameDescription
requestListOSPolicyAssignmentReportsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListOSPolicyAssignmentReportsResponse, OSPolicyAssignmentReport>

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
NameDescription
requestListOSPolicyAssignmentRevisionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListOSPolicyAssignmentRevisionsResponse, OSPolicyAssignment>

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
NameDescription
requestListOSPolicyAssignmentRevisionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListOSPolicyAssignmentRevisionsResponse, OSPolicyAssignment>

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
NameDescription
requestListOSPolicyAssignmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListOSPolicyAssignmentsResponse, OSPolicyAssignment>

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
NameDescription
requestListOSPolicyAssignmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListOSPolicyAssignmentsResponse, OSPolicyAssignment>

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
NameDescription
requestListVulnerabilityReportsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListVulnerabilityReportsResponse, VulnerabilityReport>

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
NameDescription
requestListVulnerabilityReportsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListVulnerabilityReportsResponse, VulnerabilityReport>

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
NameDescription
requestUpdateOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>

The RPC response.

Overrides

UpdateOSPolicyAssignmentAsync(UpdateOSPolicyAssignmentRequest, CallSettings)

public override async 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
NameDescription
requestUpdateOSPolicyAssignmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<OSPolicyAssignment, OSPolicyAssignmentOperationMetadata>>

A Task containing the RPC response.

Overrides