Google Cloud OS Config v1 API - Class OsConfigService.OsConfigServiceBase (2.3.0)

[BindServiceMethod(typeof(OsConfigService), "BindService")]
public abstract class OsConfigService.OsConfigServiceBase

Reference documentation and code samples for the Google Cloud OS Config v1 API class OsConfigService.OsConfigServiceBase.

Base class for server-side implementations of OsConfigService

Inheritance

object > OsConfigService.OsConfigServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`request`	`CancelPatchJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchJob`	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
Name	Description
`request`	`CreatePatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchDeployment`	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
Name	Description
`request`	`DeletePatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	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
Name	Description
`request`	`ExecutePatchJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchJob`	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
Name	Description
`request`	`GetPatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchDeployment`	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
Name	Description
`request`	`GetPatchJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchJob`	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
Name	Description
`request`	`ListPatchDeploymentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPatchDeploymentsResponse`	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
Name	Description
`request`	`ListPatchJobInstanceDetailsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPatchJobInstanceDetailsResponse`	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
Name	Description
`request`	`ListPatchJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPatchJobsResponse`	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
Name	Description
`request`	`PausePatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchDeployment`	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
Name	Description
`request`	`ResumePatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchDeployment`	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
Name	Description
`request`	`UpdatePatchDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPatchDeployment`	The response to send back to the client (wrapped by a task).