public sealed class OsConfigServiceClientImpl : OsConfigServiceClientOsConfigService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.OsConfig.V1Assembly
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(OsConfigService.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 |
OsConfigService.OsConfigServiceClientThe underlying gRPC client. |
settings |
OsConfigServiceSettingsThe base OsConfigServiceSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override OsConfigService.OsConfigServiceClient GrpcClient { get; }The underlying gRPC OsConfigService client
| Property Value | |
|---|---|
| Type | Description |
OsConfigService.OsConfigServiceClient |
|
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 |
CancelPatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchJob |
The RPC response. |
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 |
CancelPatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchJob> |
A Task containing the RPC response. |
CreatePatchDeployment(CreatePatchDeploymentRequest, CallSettings)
public override PatchDeployment CreatePatchDeployment(CreatePatchDeploymentRequest request, CallSettings callSettings = null)Create an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchDeployment |
The RPC response. |
CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CallSettings)
public override Task<PatchDeployment> CreatePatchDeploymentAsync(CreatePatchDeploymentRequest request, CallSettings callSettings = null)Create an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchDeployment> |
A Task containing the RPC response. |
DeletePatchDeployment(DeletePatchDeploymentRequest, CallSettings)
public override void DeletePatchDeployment(DeletePatchDeploymentRequest request, CallSettings callSettings = null)Delete an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CallSettings)
public override Task DeletePatchDeploymentAsync(DeletePatchDeploymentRequest request, CallSettings callSettings = null)Delete an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
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 |
ExecutePatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchJob |
The RPC response. |
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 |
ExecutePatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchJob> |
A Task containing the RPC response. |
GetPatchDeployment(GetPatchDeploymentRequest, CallSettings)
public override PatchDeployment GetPatchDeployment(GetPatchDeploymentRequest request, CallSettings callSettings = null)Get an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchDeployment |
The RPC response. |
GetPatchDeploymentAsync(GetPatchDeploymentRequest, CallSettings)
public override Task<PatchDeployment> GetPatchDeploymentAsync(GetPatchDeploymentRequest request, CallSettings callSettings = null)Get an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchDeployment> |
A Task containing the RPC response. |
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 |
GetPatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchJob |
The RPC response. |
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 |
GetPatchJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchJob> |
A Task containing the RPC response. |
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 |
ListPatchDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> |
A pageable sequence of PatchDeployment resources. |
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 |
ListPatchDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> |
A pageable asynchronous sequence of PatchDeployment resources. |
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 |
ListPatchJobInstanceDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> |
A pageable sequence of PatchJobInstanceDetails resources. |
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 |
ListPatchJobInstanceDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> |
A pageable asynchronous sequence of PatchJobInstanceDetails resources. |
ListPatchJobs(ListPatchJobsRequest, CallSettings)
public override PagedEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobs(ListPatchJobsRequest request, CallSettings callSettings = null)Get a list of patch jobs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPatchJobsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListPatchJobsResponse, PatchJob> |
A pageable sequence of PatchJob resources. |
ListPatchJobsAsync(ListPatchJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobsAsync(ListPatchJobsRequest request, CallSettings callSettings = null)Get a list of patch jobs.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPatchJobsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> |
A pageable asynchronous sequence of PatchJob resources. |
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 |
PausePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchDeployment |
The RPC response. |
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 |
PausePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchDeployment> |
A Task containing the RPC response. |
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 |
ResumePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchDeployment |
The RPC response. |
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 |
ResumePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchDeployment> |
A Task containing the RPC response. |
UpdatePatchDeployment(UpdatePatchDeploymentRequest, CallSettings)
public override PatchDeployment UpdatePatchDeployment(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)Update an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PatchDeployment |
The RPC response. |
UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CallSettings)
public override Task<PatchDeployment> UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)Update an OS Config patch deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePatchDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PatchDeployment> |
A Task containing the RPC response. |