Class CloudShellServiceGrpc.CloudShellServiceFutureStub (2.28.0)

public static final class CloudShellServiceGrpc.CloudShellServiceFutureStub extends AbstractFutureStub<CloudShellServiceGrpc.CloudShellServiceFutureStub>

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

API for interacting with Google Cloud Shell. Each user of Cloud Shell has at least one environment, which has the ID "default". Environment consists of a Docker image defining what is installed on the environment and a home directory containing the user's data that will remain across sessions. Clients use this API to start and fetch information about their environment, which can then be used to connect to that environment via a separate SSH client.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudShellServiceGrpc.CloudShellServiceFutureStub

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

addPublicKey(AddPublicKeyRequest request)

public ListenableFuture<Operation> addPublicKey(AddPublicKeyRequest request)

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

Parameter
Name	Description
`request`	`AddPublicKeyRequest`

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

authorizeEnvironment(AuthorizeEnvironmentRequest request)

public ListenableFuture<Operation> authorizeEnvironment(AuthorizeEnvironmentRequest request)

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

Parameter
Name	Description
`request`	`AuthorizeEnvironmentRequest`

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

build(Channel channel, CallOptions callOptions)

protected CloudShellServiceGrpc.CloudShellServiceFutureStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
`CloudShellServiceGrpc.CloudShellServiceFutureStub`

Overrides

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

getEnvironment(GetEnvironmentRequest request)

public ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

Parameter
Name	Description
`request`	`GetEnvironmentRequest`

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

removePublicKey(RemovePublicKeyRequest request)

public ListenableFuture<Operation> removePublicKey(RemovePublicKeyRequest request)

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

Parameter
Name	Description
`request`	`RemovePublicKeyRequest`

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

startEnvironment(StartEnvironmentRequest request)

public ListenableFuture<Operation> startEnvironment(StartEnvironmentRequest request)

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

Parameter
Name	Description
`request`	`StartEnvironmentRequest`

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