Class OsConfigService.OsConfigServiceBase (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
[BindServiceMethod(typeof(OsConfigService), "BindService")]
public abstract class OsConfigServiceBase

Base class for server-side implementations of OsConfigService

Inheritance

Object > OsConfigService.OsConfigServiceBase

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Methods

CancelPatchJob(CancelPatchJobRequest, ServerCallContext)

public virtual Task<PatchJob> CancelPatchJob(CancelPatchJobRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestCancelPatchJobRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchJob>

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

CreatePatchDeployment(CreatePatchDeploymentRequest, ServerCallContext)

public virtual Task<PatchDeployment> CreatePatchDeployment(CreatePatchDeploymentRequest request, ServerCallContext context)

Create an OS Config patch deployment.

Parameters
NameDescription
requestCreatePatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchDeployment>

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

DeletePatchDeployment(DeletePatchDeploymentRequest, ServerCallContext)

public virtual Task<Empty> DeletePatchDeployment(DeletePatchDeploymentRequest request, ServerCallContext context)

Delete an OS Config patch deployment.

Parameters
NameDescription
requestDeletePatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<Empty>

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

ExecutePatchJob(ExecutePatchJobRequest, ServerCallContext)

public virtual Task<PatchJob> ExecutePatchJob(ExecutePatchJobRequest request, ServerCallContext context)

Patch VM instances by creating and running a patch job.

Parameters
NameDescription
requestExecutePatchJobRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchJob>

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

GetPatchDeployment(GetPatchDeploymentRequest, ServerCallContext)

public virtual Task<PatchDeployment> GetPatchDeployment(GetPatchDeploymentRequest request, ServerCallContext context)

Get an OS Config patch deployment.

Parameters
NameDescription
requestGetPatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchDeployment>

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

GetPatchJob(GetPatchJobRequest, ServerCallContext)

public virtual Task<PatchJob> GetPatchJob(GetPatchJobRequest request, ServerCallContext context)

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

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchJob>

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

ListPatchDeployments(ListPatchDeploymentsRequest, ServerCallContext)

public virtual Task<ListPatchDeploymentsResponse> ListPatchDeployments(ListPatchDeploymentsRequest request, ServerCallContext context)

Get a page of OS Config patch deployments.

Parameters
NameDescription
requestListPatchDeploymentsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<ListPatchDeploymentsResponse>

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

ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest, ServerCallContext)

public virtual Task<ListPatchJobInstanceDetailsResponse> ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListPatchJobInstanceDetailsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<ListPatchJobInstanceDetailsResponse>

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

ListPatchJobs(ListPatchJobsRequest, ServerCallContext)

public virtual Task<ListPatchJobsResponse> ListPatchJobs(ListPatchJobsRequest request, ServerCallContext context)

Get a list of patch jobs.

Parameters
NameDescription
requestListPatchJobsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<ListPatchJobsResponse>

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

PausePatchDeployment(PausePatchDeploymentRequest, ServerCallContext)

public virtual Task<PatchDeployment> PausePatchDeployment(PausePatchDeploymentRequest request, ServerCallContext context)

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Parameters
NameDescription
requestPausePatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchDeployment>

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

ResumePatchDeployment(ResumePatchDeploymentRequest, ServerCallContext)

public virtual Task<PatchDeployment> ResumePatchDeployment(ResumePatchDeploymentRequest request, ServerCallContext context)

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Parameters
NameDescription
requestResumePatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchDeployment>

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

UpdatePatchDeployment(UpdatePatchDeploymentRequest, ServerCallContext)

public virtual Task<PatchDeployment> UpdatePatchDeployment(UpdatePatchDeploymentRequest request, ServerCallContext context)

Update an OS Config patch deployment.

Parameters
NameDescription
requestUpdatePatchDeploymentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<PatchDeployment>

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