Google Cloud OS Config v1 API - Class OsConfigServiceClientImpl (2.5.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

Inherited Members

OsConfigServiceClient.DefaultEndpoint

OsConfigServiceClient.DefaultScopes

OsConfigServiceClient.ServiceMetadata

OsConfigServiceClient.CreateAsync(CancellationToken)

OsConfigServiceClient.Create()

OsConfigServiceClient.ShutdownDefaultChannelsAsync()

OsConfigServiceClient.ExecutePatchJobAsync(ExecutePatchJobRequest, CancellationToken)

OsConfigServiceClient.GetPatchJobAsync(GetPatchJobRequest, CancellationToken)

OsConfigServiceClient.GetPatchJob(string, CallSettings)

OsConfigServiceClient.GetPatchJobAsync(string, CallSettings)

OsConfigServiceClient.GetPatchJobAsync(string, CancellationToken)

OsConfigServiceClient.GetPatchJob(PatchJobName, CallSettings)

OsConfigServiceClient.GetPatchJobAsync(PatchJobName, CallSettings)

OsConfigServiceClient.GetPatchJobAsync(PatchJobName, CancellationToken)

OsConfigServiceClient.CancelPatchJobAsync(CancelPatchJobRequest, CancellationToken)

OsConfigServiceClient.ListPatchJobs(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobsAsync(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobs(ProjectName, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobsAsync(ProjectName, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobInstanceDetails(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobInstanceDetailsAsync(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobInstanceDetails(PatchJobName, string, int?, CallSettings)

OsConfigServiceClient.ListPatchJobInstanceDetailsAsync(PatchJobName, string, int?, CallSettings)

OsConfigServiceClient.CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.CreatePatchDeployment(string, PatchDeployment, string, CallSettings)

OsConfigServiceClient.CreatePatchDeploymentAsync(string, PatchDeployment, string, CallSettings)

OsConfigServiceClient.CreatePatchDeploymentAsync(string, PatchDeployment, string, CancellationToken)

OsConfigServiceClient.CreatePatchDeployment(ProjectName, PatchDeployment, string, CallSettings)

OsConfigServiceClient.CreatePatchDeploymentAsync(ProjectName, PatchDeployment, string, CallSettings)

OsConfigServiceClient.CreatePatchDeploymentAsync(ProjectName, PatchDeployment, string, CancellationToken)

OsConfigServiceClient.GetPatchDeploymentAsync(GetPatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.GetPatchDeployment(string, CallSettings)

OsConfigServiceClient.GetPatchDeploymentAsync(string, CallSettings)

OsConfigServiceClient.GetPatchDeploymentAsync(string, CancellationToken)

OsConfigServiceClient.GetPatchDeployment(PatchDeploymentName, CallSettings)

OsConfigServiceClient.GetPatchDeploymentAsync(PatchDeploymentName, CallSettings)

OsConfigServiceClient.GetPatchDeploymentAsync(PatchDeploymentName, CancellationToken)

OsConfigServiceClient.ListPatchDeployments(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchDeploymentsAsync(string, string, int?, CallSettings)

OsConfigServiceClient.ListPatchDeployments(ProjectName, string, int?, CallSettings)

OsConfigServiceClient.ListPatchDeploymentsAsync(ProjectName, string, int?, CallSettings)

OsConfigServiceClient.DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.DeletePatchDeployment(string, CallSettings)

OsConfigServiceClient.DeletePatchDeploymentAsync(string, CallSettings)

OsConfigServiceClient.DeletePatchDeploymentAsync(string, CancellationToken)

OsConfigServiceClient.DeletePatchDeployment(PatchDeploymentName, CallSettings)

OsConfigServiceClient.DeletePatchDeploymentAsync(PatchDeploymentName, CallSettings)

OsConfigServiceClient.DeletePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

OsConfigServiceClient.UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.UpdatePatchDeployment(PatchDeployment, FieldMask, CallSettings)

OsConfigServiceClient.UpdatePatchDeploymentAsync(PatchDeployment, FieldMask, CallSettings)

OsConfigServiceClient.UpdatePatchDeploymentAsync(PatchDeployment, FieldMask, CancellationToken)

OsConfigServiceClient.PausePatchDeploymentAsync(PausePatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.PausePatchDeployment(string, CallSettings)

OsConfigServiceClient.PausePatchDeploymentAsync(string, CallSettings)

OsConfigServiceClient.PausePatchDeploymentAsync(string, CancellationToken)

OsConfigServiceClient.PausePatchDeployment(PatchDeploymentName, CallSettings)

OsConfigServiceClient.PausePatchDeploymentAsync(PatchDeploymentName, CallSettings)

OsConfigServiceClient.PausePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

OsConfigServiceClient.ResumePatchDeploymentAsync(ResumePatchDeploymentRequest, CancellationToken)

OsConfigServiceClient.ResumePatchDeployment(string, CallSettings)

OsConfigServiceClient.ResumePatchDeploymentAsync(string, CallSettings)

OsConfigServiceClient.ResumePatchDeploymentAsync(string, CancellationToken)

OsConfigServiceClient.ResumePatchDeployment(PatchDeploymentName, CallSettings)

OsConfigServiceClient.ResumePatchDeploymentAsync(PatchDeploymentName, CallSettings)

OsConfigServiceClient.ResumePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

OsConfigServiceClient.GrpcClient

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

OsConfigServiceClient.CancelPatchJob(CancelPatchJobRequest, CallSettings)

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

OsConfigServiceClient.CancelPatchJobAsync(CancelPatchJobRequest, CallSettings)

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

OsConfigServiceClient.CreatePatchDeployment(CreatePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.DeletePatchDeployment(DeletePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.ExecutePatchJob(ExecutePatchJobRequest, CallSettings)

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

OsConfigServiceClient.ExecutePatchJobAsync(ExecutePatchJobRequest, CallSettings)

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

OsConfigServiceClient.GetPatchDeployment(GetPatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.GetPatchDeploymentAsync(GetPatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.GetPatchJob(GetPatchJobRequest, CallSettings)

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

OsConfigServiceClient.GetPatchJobAsync(GetPatchJobRequest, CallSettings)

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

OsConfigServiceClient.ListPatchDeployments(ListPatchDeploymentsRequest, CallSettings)

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

OsConfigServiceClient.ListPatchDeploymentsAsync(ListPatchDeploymentsRequest, CallSettings)

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

OsConfigServiceClient.ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest, CallSettings)

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

OsConfigServiceClient.ListPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest, CallSettings)

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

OsConfigServiceClient.ListPatchJobs(ListPatchJobsRequest, CallSettings)

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

OsConfigServiceClient.ListPatchJobsAsync(ListPatchJobsRequest, CallSettings)

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

OsConfigServiceClient.PausePatchDeployment(PausePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.PausePatchDeploymentAsync(PausePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.ResumePatchDeployment(ResumePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.ResumePatchDeploymentAsync(ResumePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.UpdatePatchDeployment(UpdatePatchDeploymentRequest, CallSettings)

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

OsConfigServiceClient.UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CallSettings)