Interface CloudShellServiceGrpc.AsyncService (2.36.0)

Version 2.36.0

• 2.52.0 (latest)
• 2.51.0
• 2.50.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.1.11

public static interface CloudShellServiceGrpc.AsyncService

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.

Methods

addPublicKey(AddPublicKeyRequest request, StreamObserver<Operation> responseObserver)

public default void addPublicKey(AddPublicKeyRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	AddPublicKeyRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

authorizeEnvironment(AuthorizeEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public default void authorizeEnvironment(AuthorizeEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	AuthorizeEnvironmentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

public default void getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

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

Parameters
Name	Description
request	GetEnvironmentRequest
responseObserver	io.grpc.stub.StreamObserver<Environment>

removePublicKey(RemovePublicKeyRequest request, StreamObserver<Operation> responseObserver)

public default void removePublicKey(RemovePublicKeyRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	RemovePublicKeyRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

startEnvironment(StartEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public default void startEnvironment(StartEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	StartEnvironmentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>