Package com.google.cloud.shell.v1

Class CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub>
com.google.cloud.shell.v1.CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub
Enclosing class:
CloudShellServiceGrpc
public static final class CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub>
A stub to allow clients to do synchronous 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.

  • Method Details

    • build

      protected CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<CloudShellServiceGrpc.CloudShellServiceBlockingV2Stub>

    • getEnvironment

      public Environment getEnvironment(GetEnvironmentRequest request) throws io.grpc.StatusException
       Gets an environment. Returns NOT_FOUND if the environment does not exist.
      Throws:
      io.grpc.StatusException

    • startEnvironment

      public Operation startEnvironment(StartEnvironmentRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • authorizeEnvironment

      public Operation authorizeEnvironment(AuthorizeEnvironmentRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • addPublicKey

      public Operation addPublicKey(AddPublicKeyRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • removePublicKey

      public Operation removePublicKey(RemovePublicKeyRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException