Class OsConfigServiceGrpc.OsConfigServiceFutureStub (2.43.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

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected OsConfigServiceGrpc.OsConfigServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`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
Name	Description
`request`	`PatchJobs.CancelPatchJobRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GuestPolicies.CreateGuestPolicyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.CreatePatchDeploymentRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GuestPolicies.DeleteGuestPolicyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.DeletePatchDeploymentRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchJobs.ExecutePatchJobRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GuestPolicies.GetGuestPolicyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.GetPatchDeploymentRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchJobs.GetPatchJobRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GuestPolicies.ListGuestPoliciesRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.ListPatchDeploymentsRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchJobs.ListPatchJobInstanceDetailsRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchJobs.ListPatchJobsRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GuestPolicies.LookupEffectiveGuestPolicyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.PausePatchDeploymentRequest`

Returns
Type	Description
`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
Name	Description
`request`	`PatchDeployments.ResumePatchDeploymentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PatchDeployment>`

updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

public ListenableFuture<GuestPolicies.GuestPolicy> updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

Update an OS Config guest policy.

Parameter
Name	Description
`request`	`GuestPolicies.UpdateGuestPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<GuestPolicy>`

updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

public ListenableFuture<PatchDeployments.PatchDeployment> updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

Update an OS Config patch deployment.

Parameter
Name	Description
`request`	`PatchDeployments.UpdatePatchDeploymentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PatchDeployment>`