Package com.google.cloud.shell.v1

Interface CloudShellServiceGrpc.AsyncService

All Known Implementing Classes:
CloudShellServiceGrpc.CloudShellServiceImplBase
Enclosing class:
CloudShellServiceGrpc
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.

  • Method Details

    • getEnvironment

      default void getEnvironment(GetEnvironmentRequest request, io.grpc.stub.StreamObserver<Environment> responseObserver)
       Gets an environment. Returns NOT_FOUND if the environment does not exist.

    • startEnvironment

      default void startEnvironment(StartEnvironmentRequest request, io.grpc.stub.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.

    • authorizeEnvironment

      default void authorizeEnvironment(AuthorizeEnvironmentRequest request, io.grpc.stub.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.

    • addPublicKey

      default void addPublicKey(AddPublicKeyRequest request, io.grpc.stub.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.

    • removePublicKey

      default void removePublicKey(RemovePublicKeyRequest request, io.grpc.stub.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.