Class OsConfigServiceGrpc.OsConfigServiceFutureStub (2.19.0)

public static final class OsConfigServiceGrpc.OsConfigServiceFutureStub extends AbstractFutureStub<OsConfigServiceGrpc.OsConfigServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > OsConfigServiceGrpc.OsConfigServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected OsConfigServiceGrpc.OsConfigServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
OsConfigServiceGrpc.OsConfigServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

public ListenableFuture<PatchJobs.PatchJob> cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

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

Parameter
NameDescription
requestPatchJobs.CancelPatchJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchJob>

createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

public ListenableFuture<GuestPolicies.GuestPolicy> createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

Create an OS Config guest policy.

Parameter
NameDescription
requestGuestPolicies.CreateGuestPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GuestPolicy>

createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

public ListenableFuture<PatchDeployments.PatchDeployment> createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

Create an OS Config patch deployment.

Parameter
NameDescription
requestPatchDeployments.CreatePatchDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchDeployment>

deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

public ListenableFuture<Empty> deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

Delete an OS Config guest policy.

Parameter
NameDescription
requestGuestPolicies.DeleteGuestPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

public ListenableFuture<Empty> deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

Delete an OS Config patch deployment.

Parameter
NameDescription
requestPatchDeployments.DeletePatchDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

executePatchJob(PatchJobs.ExecutePatchJobRequest request)

public ListenableFuture<PatchJobs.PatchJob> executePatchJob(PatchJobs.ExecutePatchJobRequest request)

Patch VM instances by creating and running a patch job.

Parameter
NameDescription
requestPatchJobs.ExecutePatchJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchJob>

getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

public ListenableFuture<GuestPolicies.GuestPolicy> getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

Get an OS Config guest policy.

Parameter
NameDescription
requestGuestPolicies.GetGuestPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GuestPolicy>

getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

public ListenableFuture<PatchDeployments.PatchDeployment> getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

Get an OS Config patch deployment.

Parameter
NameDescription
requestPatchDeployments.GetPatchDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchDeployment>

getPatchJob(PatchJobs.GetPatchJobRequest request)

public ListenableFuture<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
NameDescription
requestPatchJobs.GetPatchJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchJob>

listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

public ListenableFuture<GuestPolicies.ListGuestPoliciesResponse> listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

Get a page of OS Config guest policies.

Parameter
NameDescription
requestGuestPolicies.ListGuestPoliciesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListGuestPoliciesResponse>

listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

public ListenableFuture<PatchDeployments.ListPatchDeploymentsResponse> listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

Get a page of OS Config patch deployments.

Parameter
NameDescription
requestPatchDeployments.ListPatchDeploymentsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListPatchDeploymentsResponse>

listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

public ListenableFuture<PatchJobs.ListPatchJobInstanceDetailsResponse> listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

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

Parameter
NameDescription
requestPatchJobs.ListPatchJobInstanceDetailsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListPatchJobInstanceDetailsResponse>

listPatchJobs(PatchJobs.ListPatchJobsRequest request)

public ListenableFuture<PatchJobs.ListPatchJobsResponse> listPatchJobs(PatchJobs.ListPatchJobsRequest request)

Get a list of patch jobs.

Parameter
NameDescription
requestPatchJobs.ListPatchJobsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListPatchJobsResponse>

lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)

public ListenableFuture<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
NameDescription
requestGuestPolicies.LookupEffectiveGuestPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EffectiveGuestPolicy>

pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

public ListenableFuture<PatchDeployments.PatchDeployment> pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

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

Parameter
NameDescription
requestPatchDeployments.PausePatchDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchDeployment>

resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)

public ListenableFuture<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
NameDescription
requestPatchDeployments.ResumePatchDeploymentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<PatchDeployment>