Google Cloud OS Config v1 API - Class OsConfigZonalService.OsConfigZonalServiceBase (2.3.0)

[BindServiceMethod(typeof(OsConfigZonalService), "BindService")]
public abstract class OsConfigZonalService.OsConfigZonalServiceBase

Reference documentation and code samples for the Google Cloud OS Config v1 API class OsConfigZonalService.OsConfigZonalServiceBase.

Base class for server-side implementations of OsConfigZonalService

Inheritance

object > OsConfigZonalService.OsConfigZonalServiceBase

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Methods

CreateOSPolicyAssignment(CreateOSPolicyAssignmentRequest, ServerCallContext)

public virtual Task<Operation> CreateOSPolicyAssignment(CreateOSPolicyAssignmentRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteOSPolicyAssignment(DeleteOSPolicyAssignmentRequest, ServerCallContext)

public virtual Task<Operation> DeleteOSPolicyAssignment(DeleteOSPolicyAssignmentRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetInventory(GetInventoryRequest, ServerCallContext)

public virtual Task<Inventory> GetInventory(GetInventoryRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskInventory

The response to send back to the client (wrapped by a task).

GetOSPolicyAssignment(GetOSPolicyAssignmentRequest, ServerCallContext)

public virtual Task<OSPolicyAssignment> GetOSPolicyAssignment(GetOSPolicyAssignmentRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOSPolicyAssignment

The response to send back to the client (wrapped by a task).

GetOSPolicyAssignmentReport(GetOSPolicyAssignmentReportRequest, ServerCallContext)

public virtual Task<OSPolicyAssignmentReport> GetOSPolicyAssignmentReport(GetOSPolicyAssignmentReportRequest request, ServerCallContext context)

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

Parameters
Name Description
request GetOSPolicyAssignmentReportRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOSPolicyAssignmentReport

The response to send back to the client (wrapped by a task).

GetVulnerabilityReport(GetVulnerabilityReportRequest, ServerCallContext)

public virtual Task<VulnerabilityReport> GetVulnerabilityReport(GetVulnerabilityReportRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVulnerabilityReport

The response to send back to the client (wrapped by a task).

ListInventories(ListInventoriesRequest, ServerCallContext)

public virtual Task<ListInventoriesResponse> ListInventories(ListInventoriesRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListInventoriesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListInventoriesResponse

The response to send back to the client (wrapped by a task).

ListOSPolicyAssignmentReports(ListOSPolicyAssignmentReportsRequest, ServerCallContext)

public virtual Task<ListOSPolicyAssignmentReportsResponse> ListOSPolicyAssignmentReports(ListOSPolicyAssignmentReportsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListOSPolicyAssignmentReportsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListOSPolicyAssignmentReportsResponse

The response to send back to the client (wrapped by a task).

ListOSPolicyAssignmentRevisions(ListOSPolicyAssignmentRevisionsRequest, ServerCallContext)

public virtual Task<ListOSPolicyAssignmentRevisionsResponse> ListOSPolicyAssignmentRevisions(ListOSPolicyAssignmentRevisionsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListOSPolicyAssignmentRevisionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListOSPolicyAssignmentRevisionsResponse

The response to send back to the client (wrapped by a task).

ListOSPolicyAssignments(ListOSPolicyAssignmentsRequest, ServerCallContext)

public virtual Task<ListOSPolicyAssignmentsResponse> ListOSPolicyAssignments(ListOSPolicyAssignmentsRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListOSPolicyAssignmentsResponse

The response to send back to the client (wrapped by a task).

ListVulnerabilityReports(ListVulnerabilityReportsRequest, ServerCallContext)

public virtual Task<ListVulnerabilityReportsResponse> ListVulnerabilityReports(ListVulnerabilityReportsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListVulnerabilityReportsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListVulnerabilityReportsResponse

The response to send back to the client (wrapped by a task).

UpdateOSPolicyAssignment(UpdateOSPolicyAssignmentRequest, ServerCallContext)

public virtual Task<Operation> UpdateOSPolicyAssignment(UpdateOSPolicyAssignmentRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).