Class OsConfigServiceGrpc.OsConfigServiceBlockingStub (2.55.0)

public static final class OsConfigServiceGrpc.OsConfigServiceBlockingStub extends AbstractBlockingStub<OsConfigServiceGrpc.OsConfigServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service OsConfigService.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > OsConfigServiceGrpc.OsConfigServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected OsConfigServiceGrpc.OsConfigServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
OsConfigServiceGrpc.OsConfigServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

public PatchJobs.PatchJob cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

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

Parameter
Name Description
request PatchJobs.CancelPatchJobRequest
Returns
Type Description
PatchJobs.PatchJob

createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

public GuestPolicies.GuestPolicy createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

Create an OS Config guest policy.

Parameter
Name Description
request GuestPolicies.CreateGuestPolicyRequest
Returns
Type Description
GuestPolicies.GuestPolicy

createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

public PatchDeployments.PatchDeployment createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

Create an OS Config patch deployment.

Parameter
Name Description
request PatchDeployments.CreatePatchDeploymentRequest
Returns
Type Description
PatchDeployments.PatchDeployment

deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

public Empty deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

Delete an OS Config guest policy.

Parameter
Name Description
request GuestPolicies.DeleteGuestPolicyRequest
Returns
Type Description
Empty

deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

public Empty deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

Delete an OS Config patch deployment.

Parameter
Name Description
request PatchDeployments.DeletePatchDeploymentRequest
Returns
Type Description
Empty

executePatchJob(PatchJobs.ExecutePatchJobRequest request)

public PatchJobs.PatchJob executePatchJob(PatchJobs.ExecutePatchJobRequest request)

Patch VM instances by creating and running a patch job.

Parameter
Name Description
request PatchJobs.ExecutePatchJobRequest
Returns
Type Description
PatchJobs.PatchJob

getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

public GuestPolicies.GuestPolicy getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

Get an OS Config guest policy.

Parameter
Name Description
request GuestPolicies.GetGuestPolicyRequest
Returns
Type Description
GuestPolicies.GuestPolicy

getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

public PatchDeployments.PatchDeployment getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

Get an OS Config patch deployment.

Parameter
Name Description
request PatchDeployments.GetPatchDeploymentRequest
Returns
Type Description
PatchDeployments.PatchDeployment

getPatchJob(PatchJobs.GetPatchJobRequest request)

public PatchJobs.PatchJob getPatchJob(PatchJobs.GetPatchJobRequest request)

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameter
Name Description
request PatchJobs.GetPatchJobRequest
Returns
Type Description
PatchJobs.PatchJob

listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

public GuestPolicies.ListGuestPoliciesResponse listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

Get a page of OS Config guest policies.

Parameter
Name Description
request GuestPolicies.ListGuestPoliciesRequest
Returns
Type Description
GuestPolicies.ListGuestPoliciesResponse

listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

public PatchDeployments.ListPatchDeploymentsResponse listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

Get a page of OS Config patch deployments.

Parameter
Name Description
request PatchDeployments.ListPatchDeploymentsRequest
Returns
Type Description
PatchDeployments.ListPatchDeploymentsResponse

listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

public PatchJobs.ListPatchJobInstanceDetailsResponse listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

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

Parameter
Name Description
request PatchJobs.ListPatchJobInstanceDetailsRequest
Returns
Type Description
PatchJobs.ListPatchJobInstanceDetailsResponse

listPatchJobs(PatchJobs.ListPatchJobsRequest request)

public PatchJobs.ListPatchJobsResponse listPatchJobs(PatchJobs.ListPatchJobsRequest request)

Get a list of patch jobs.

Parameter
Name Description
request PatchJobs.ListPatchJobsRequest
Returns
Type Description
PatchJobs.ListPatchJobsResponse

lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)

public GuestPolicies.EffectiveGuestPolicy lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)

Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

Parameter
Name Description
request GuestPolicies.LookupEffectiveGuestPolicyRequest
Returns
Type Description
GuestPolicies.EffectiveGuestPolicy

pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

public PatchDeployments.PatchDeployment pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

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

Parameter
Name Description
request PatchDeployments.PausePatchDeploymentRequest
Returns
Type Description
PatchDeployments.PatchDeployment

resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)

public PatchDeployments.PatchDeployment resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)

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

Parameter
Name Description
request PatchDeployments.ResumePatchDeploymentRequest
Returns
Type Description
PatchDeployments.PatchDeployment

updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

public GuestPolicies.GuestPolicy updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

Update an OS Config guest policy.

Parameter
Name Description
request GuestPolicies.UpdateGuestPolicyRequest
Returns
Type Description
GuestPolicies.GuestPolicy

updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

public PatchDeployments.PatchDeployment updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

Update an OS Config patch deployment.

Parameter
Name Description
request PatchDeployments.UpdatePatchDeploymentRequest
Returns
Type Description
PatchDeployments.PatchDeployment