Google Cloud OS Config v1 API - Class OsConfigServiceClientImpl (2.4.0)

public sealed class OsConfigServiceClientImpl : OsConfigServiceClient

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

OsConfigService client wrapper implementation, for convenient use.

Inheritance

object > OsConfigServiceClient > OsConfigServiceClientImpl

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Remarks

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Constructors

OsConfigServiceClientImpl(OsConfigServiceClient, OsConfigServiceSettings, ILogger)

public OsConfigServiceClientImpl(OsConfigService.OsConfigServiceClient grpcClient, OsConfigServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient OsConfigServiceOsConfigServiceClient

The underlying gRPC client.
settings OsConfigServiceSettings

The base OsConfigServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override OsConfigService.OsConfigServiceClient GrpcClient { get; }

The underlying gRPC OsConfigService client

Property Value
Type Description
OsConfigServiceOsConfigServiceClient
Overrides

Methods

CancelPatchJob(CancelPatchJobRequest, CallSettings)

public override PatchJob CancelPatchJob(CancelPatchJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CancelPatchJobRequest

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
PatchJob

The RPC response.
Overrides

CancelPatchJobAsync(CancelPatchJobRequest, CallSettings)

public override Task<PatchJob> CancelPatchJobAsync(CancelPatchJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CancelPatchJobRequest

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
TaskPatchJob

A Task containing the RPC response.
Overrides

CreatePatchDeployment(CreatePatchDeploymentRequest, CallSettings)

public override PatchDeployment CreatePatchDeployment(CreatePatchDeploymentRequest request, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
Name Description
request CreatePatchDeploymentRequest

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
PatchDeployment

The RPC response.
Overrides

CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CallSettings)

public override Task<PatchDeployment> CreatePatchDeploymentAsync(CreatePatchDeploymentRequest request, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
Name Description
request CreatePatchDeploymentRequest

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
TaskPatchDeployment

A Task containing the RPC response.
Overrides

DeletePatchDeployment(DeletePatchDeploymentRequest, CallSettings)

public override void DeletePatchDeployment(DeletePatchDeploymentRequest request, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
Name Description
request DeletePatchDeploymentRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CallSettings)

public override Task DeletePatchDeploymentAsync(DeletePatchDeploymentRequest request, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
Name Description
request DeletePatchDeploymentRequest

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
Task

A Task containing the RPC response.
Overrides

ExecutePatchJob(ExecutePatchJobRequest, CallSettings)

public override PatchJob ExecutePatchJob(ExecutePatchJobRequest request, CallSettings callSettings = null)

Patch VM instances by creating and running a patch job.

Parameters
Name Description
request ExecutePatchJobRequest

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
PatchJob

The RPC response.
Overrides

ExecutePatchJobAsync(ExecutePatchJobRequest, CallSettings)

public override Task<PatchJob> ExecutePatchJobAsync(ExecutePatchJobRequest request, CallSettings callSettings = null)

Patch VM instances by creating and running a patch job.

Parameters
Name Description
request ExecutePatchJobRequest

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
TaskPatchJob

A Task containing the RPC response.
Overrides

GetPatchDeployment(GetPatchDeploymentRequest, CallSettings)

public override PatchDeployment GetPatchDeployment(GetPatchDeploymentRequest request, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
Name Description
request GetPatchDeploymentRequest

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
PatchDeployment

The RPC response.
Overrides

GetPatchDeploymentAsync(GetPatchDeploymentRequest, CallSettings)

public override Task<PatchDeployment> GetPatchDeploymentAsync(GetPatchDeploymentRequest request, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
Name Description
request GetPatchDeploymentRequest

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
TaskPatchDeployment

A Task containing the RPC response.
Overrides

GetPatchJob(GetPatchJobRequest, CallSettings)

public override PatchJob GetPatchJob(GetPatchJobRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

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

The RPC response.
Overrides

GetPatchJobAsync(GetPatchJobRequest, CallSettings)

public override Task<PatchJob> GetPatchJobAsync(GetPatchJobRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

ListPatchDeployments(ListPatchDeploymentsRequest, CallSettings)

public override PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeployments(ListPatchDeploymentsRequest request, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
Name Description
request ListPatchDeploymentsRequest

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
PagedEnumerableListPatchDeploymentsResponsePatchDeployment

A pageable sequence of PatchDeployment resources.
Overrides

ListPatchDeploymentsAsync(ListPatchDeploymentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeploymentsAsync(ListPatchDeploymentsRequest request, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
Name Description
request ListPatchDeploymentsRequest

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
PagedAsyncEnumerableListPatchDeploymentsResponsePatchDeployment

A pageable asynchronous sequence of PatchDeployment resources.
Overrides

ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest, CallSettings)

public override PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListPatchJobInstanceDetailsRequest

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
PagedEnumerableListPatchJobInstanceDetailsResponsePatchJobInstanceDetails

A pageable sequence of PatchJobInstanceDetails resources.
Overrides

ListPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListPatchJobInstanceDetailsRequest

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
PagedAsyncEnumerableListPatchJobInstanceDetailsResponsePatchJobInstanceDetails

A pageable asynchronous sequence of PatchJobInstanceDetails resources.
Overrides

ListPatchJobs(ListPatchJobsRequest, CallSettings)

public override PagedEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobs(ListPatchJobsRequest request, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
Name Description
request ListPatchJobsRequest

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
PagedEnumerableListPatchJobsResponsePatchJob

A pageable sequence of PatchJob resources.
Overrides

ListPatchJobsAsync(ListPatchJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobsAsync(ListPatchJobsRequest request, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
Name Description
request ListPatchJobsRequest

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
PagedAsyncEnumerableListPatchJobsResponsePatchJob

A pageable asynchronous sequence of PatchJob resources.
Overrides

PausePatchDeployment(PausePatchDeploymentRequest, CallSettings)

public override PatchDeployment PausePatchDeployment(PausePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PausePatchDeploymentRequest

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
PatchDeployment

The RPC response.
Overrides

PausePatchDeploymentAsync(PausePatchDeploymentRequest, CallSettings)

public override Task<PatchDeployment> PausePatchDeploymentAsync(PausePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PausePatchDeploymentRequest

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
TaskPatchDeployment

A Task containing the RPC response.
Overrides

ResumePatchDeployment(ResumePatchDeploymentRequest, CallSettings)

public override PatchDeployment ResumePatchDeployment(ResumePatchDeploymentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

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

The RPC response.
Overrides

ResumePatchDeploymentAsync(ResumePatchDeploymentRequest, CallSettings)

public override Task<PatchDeployment> ResumePatchDeploymentAsync(ResumePatchDeploymentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

UpdatePatchDeployment(UpdatePatchDeploymentRequest, CallSettings)

public override PatchDeployment UpdatePatchDeployment(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
Name Description
request UpdatePatchDeploymentRequest

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
PatchDeployment

The RPC response.
Overrides

UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CallSettings)

public override Task<PatchDeployment> UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
Name Description
request UpdatePatchDeploymentRequest

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
TaskPatchDeployment

A Task containing the RPC response.
Overrides