Package com.google.cloud.shell.v1 (2.42.0)

GitHub Repository RPC Documentation REST Documentation

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.shell.v1.CloudShellServiceClient Service Description: 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

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.shell.v1.CloudShellServiceSettings Settings class to configure an instance of CloudShellServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.shell.v1.AddPublicKeyMetadata Message included in the metadata field of operations returned from AddPublicKey.
com.google.cloud.shell.v1.AddPublicKeyMetadata.Builder Message included in the metadata field of operations returned from AddPublicKey.
com.google.cloud.shell.v1.AddPublicKeyRequest Request message for AddPublicKey.
com.google.cloud.shell.v1.AddPublicKeyRequest.Builder Request message for AddPublicKey.
com.google.cloud.shell.v1.AddPublicKeyResponse Response message for AddPublicKey.
com.google.cloud.shell.v1.AddPublicKeyResponse.Builder Response message for AddPublicKey.
com.google.cloud.shell.v1.AuthorizeEnvironmentMetadata Message included in the metadata field of operations returned from AuthorizeEnvironment.
com.google.cloud.shell.v1.AuthorizeEnvironmentMetadata.Builder Message included in the metadata field of operations returned from AuthorizeEnvironment.
com.google.cloud.shell.v1.AuthorizeEnvironmentRequest Request message for AuthorizeEnvironment.
com.google.cloud.shell.v1.AuthorizeEnvironmentRequest.Builder Request message for AuthorizeEnvironment.
com.google.cloud.shell.v1.AuthorizeEnvironmentResponse Response message for AuthorizeEnvironment.
com.google.cloud.shell.v1.AuthorizeEnvironmentResponse.Builder Response message for AuthorizeEnvironment.
com.google.cloud.shell.v1.CloudShellErrorDetails Cloud-shell specific information that will be included as details in failure responses.
com.google.cloud.shell.v1.CloudShellErrorDetails.Builder Cloud-shell specific information that will be included as details in failure responses.
com.google.cloud.shell.v1.CloudShellProto
com.google.cloud.shell.v1.CloudShellServiceGrpc 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
com.google.cloud.shell.v1.CloudShellServiceGrpc.CloudShellServiceImplBase Base class for the server implementation of the service CloudShellService. API for interacting with Google Cloud Shell. Each user of Cloud Shell has at
com.google.cloud.shell.v1.CloudShellServiceSettings.Builder Builder for CloudShellServiceSettings.
com.google.cloud.shell.v1.CreateEnvironmentMetadata Message included in the metadata field of operations returned from CreateEnvironment.
com.google.cloud.shell.v1.CreateEnvironmentMetadata.Builder Message included in the metadata field of operations returned from CreateEnvironment.
com.google.cloud.shell.v1.DeleteEnvironmentMetadata Message included in the metadata field of operations returned from DeleteEnvironment.
com.google.cloud.shell.v1.DeleteEnvironmentMetadata.Builder Message included in the metadata field of operations returned from DeleteEnvironment.
com.google.cloud.shell.v1.Environment A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has
com.google.cloud.shell.v1.Environment.Builder A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has
com.google.cloud.shell.v1.EnvironmentName
com.google.cloud.shell.v1.EnvironmentName.Builder Builder for users/{user}/environments/{environment}.
com.google.cloud.shell.v1.GetEnvironmentRequest Request message for GetEnvironment.
com.google.cloud.shell.v1.GetEnvironmentRequest.Builder Request message for GetEnvironment.
com.google.cloud.shell.v1.RemovePublicKeyMetadata Message included in the metadata field of operations returned from RemovePublicKey.
com.google.cloud.shell.v1.RemovePublicKeyMetadata.Builder Message included in the metadata field of operations returned from RemovePublicKey.
com.google.cloud.shell.v1.RemovePublicKeyRequest Request message for RemovePublicKey.
com.google.cloud.shell.v1.RemovePublicKeyRequest.Builder Request message for RemovePublicKey.
com.google.cloud.shell.v1.RemovePublicKeyResponse Response message for RemovePublicKey.
com.google.cloud.shell.v1.RemovePublicKeyResponse.Builder Response message for RemovePublicKey.
com.google.cloud.shell.v1.StartEnvironmentMetadata Message included in the metadata field of operations returned from StartEnvironment.
com.google.cloud.shell.v1.StartEnvironmentMetadata.Builder Message included in the metadata field of operations returned from StartEnvironment.
com.google.cloud.shell.v1.StartEnvironmentRequest Request message for StartEnvironment.
com.google.cloud.shell.v1.StartEnvironmentRequest.Builder Request message for StartEnvironment.
com.google.cloud.shell.v1.StartEnvironmentResponse Message included in the response field of operations returned from StartEnvironment once the operation is complete.
com.google.cloud.shell.v1.StartEnvironmentResponse.Builder Message included in the response field of operations returned from StartEnvironment once the operation is complete.

Interfaces

Interface Description
com.google.cloud.shell.v1.AddPublicKeyMetadataOrBuilder
com.google.cloud.shell.v1.AddPublicKeyRequestOrBuilder
com.google.cloud.shell.v1.AddPublicKeyResponseOrBuilder
com.google.cloud.shell.v1.AuthorizeEnvironmentMetadataOrBuilder
com.google.cloud.shell.v1.AuthorizeEnvironmentRequestOrBuilder
com.google.cloud.shell.v1.AuthorizeEnvironmentResponseOrBuilder
com.google.cloud.shell.v1.CloudShellErrorDetailsOrBuilder
com.google.cloud.shell.v1.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
com.google.cloud.shell.v1.CreateEnvironmentMetadataOrBuilder
com.google.cloud.shell.v1.DeleteEnvironmentMetadataOrBuilder
com.google.cloud.shell.v1.EnvironmentOrBuilder
com.google.cloud.shell.v1.GetEnvironmentRequestOrBuilder
com.google.cloud.shell.v1.RemovePublicKeyMetadataOrBuilder
com.google.cloud.shell.v1.RemovePublicKeyRequestOrBuilder
com.google.cloud.shell.v1.RemovePublicKeyResponseOrBuilder
com.google.cloud.shell.v1.StartEnvironmentMetadataOrBuilder
com.google.cloud.shell.v1.StartEnvironmentRequestOrBuilder
com.google.cloud.shell.v1.StartEnvironmentResponseOrBuilder

Enums

Enum Description
com.google.cloud.shell.v1.CloudShellErrorDetails.CloudShellErrorCode Set of possible errors returned from API calls.
com.google.cloud.shell.v1.Environment.State Possible execution states for an environment.
com.google.cloud.shell.v1.StartEnvironmentMetadata.State Possible states an environment might transition between during startup. These states are not normally actionable by clients, but may be used to show a progress message to the user. An environment won't necessarily go