Class InstancesGrpc.InstancesFutureStub (2.28.0)

public static final class InstancesGrpc.InstancesFutureStub extends AbstractFutureStub<InstancesGrpc.InstancesFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Instances.

Manages instances of a version.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > InstancesGrpc.InstancesFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

debugInstance(DebugInstanceRequest request)

public ListenableFuture<Operation> debugInstance(DebugInstanceRequest request)

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

Parameter
NameDescription
requestDebugInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteInstance(DeleteInstanceRequest request)

public ListenableFuture<Operation> deleteInstance(DeleteInstanceRequest request)

Stops a running instance. The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment). To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch method.

Parameter
NameDescription
requestDeleteInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Gets instance information.

Parameter
NameDescription
requestGetInstanceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Instance>

listInstances(ListInstancesRequest request)

public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

Lists the instances of a version. Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

Parameter
NameDescription
requestListInstancesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>