@Generated("by gapic-generator-java")
Package com.google.cloud.shell.v1
A client to Cloud Shell API
The interfaces provided are listed below, along with usage samples.
======================= 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 environment, which can then be used to connect to that environment via a separate SSH client.
Sample for CloudShellServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
EnvironmentName name = EnvironmentName.of("[USER]", "[ENVIRONMENT]");
Environment response = cloudShellServiceClient.getEnvironment(name);
}
-
Class Summary Class Description AddPublicKeyMetadata Message included in the metadata field of operations returned from [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AddPublicKeyMetadata.Builder Message included in the metadata field of operations returned from [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AddPublicKeyRequest Request message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AddPublicKeyRequest.Builder Request message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AddPublicKeyResponse Response message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AddPublicKeyResponse.Builder Response message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].AuthorizeEnvironmentMetadata Message included in the metadata field of operations returned from [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].AuthorizeEnvironmentMetadata.Builder Message included in the metadata field of operations returned from [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].AuthorizeEnvironmentRequest Request message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].AuthorizeEnvironmentRequest.Builder Request message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].AuthorizeEnvironmentResponse Response message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].AuthorizeEnvironmentResponse.Builder Response message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].CloudShellErrorDetails Cloud-shell specific information that will be included as details in failure responses.CloudShellErrorDetails.Builder Cloud-shell specific information that will be included as details in failure responses.CloudShellProto CloudShellServiceClient Service Description: API for interacting with Google Cloud Shell.CloudShellServiceGrpc API for interacting with Google Cloud Shell.CloudShellServiceGrpc.CloudShellServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service CloudShellService.CloudShellServiceGrpc.CloudShellServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CloudShellService.CloudShellServiceGrpc.CloudShellServiceImplBase Base class for the server implementation of the service CloudShellService.CloudShellServiceGrpc.CloudShellServiceStub A stub to allow clients to do asynchronous rpc calls to service CloudShellService.CloudShellServiceSettings Settings class to configure an instance ofCloudShellServiceClient
.CloudShellServiceSettings.Builder Builder for CloudShellServiceSettings.CreateEnvironmentMetadata Message included in the metadata field of operations returned from [CreateEnvironment][google.cloud.shell.v1.CloudShellService.CreateEnvironment].CreateEnvironmentMetadata.Builder Message included in the metadata field of operations returned from [CreateEnvironment][google.cloud.shell.v1.CloudShellService.CreateEnvironment].DeleteEnvironmentMetadata Message included in the metadata field of operations returned from [DeleteEnvironment][google.cloud.shell.v1.CloudShellService.DeleteEnvironment].DeleteEnvironmentMetadata.Builder Message included in the metadata field of operations returned from [DeleteEnvironment][google.cloud.shell.v1.CloudShellService.DeleteEnvironment].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.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.EnvironmentName EnvironmentName.Builder Builder for users/{user}/environments/{environment}.GetEnvironmentRequest Request message for [GetEnvironment][google.cloud.shell.v1.CloudShellService.GetEnvironment].GetEnvironmentRequest.Builder Request message for [GetEnvironment][google.cloud.shell.v1.CloudShellService.GetEnvironment].RemovePublicKeyMetadata Message included in the metadata field of operations returned from [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].RemovePublicKeyMetadata.Builder Message included in the metadata field of operations returned from [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].RemovePublicKeyRequest Request message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].RemovePublicKeyRequest.Builder Request message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].RemovePublicKeyResponse Response message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].RemovePublicKeyResponse.Builder Response message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].StartEnvironmentMetadata Message included in the metadata field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].StartEnvironmentMetadata.Builder Message included in the metadata field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].StartEnvironmentRequest Request message for [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].StartEnvironmentRequest.Builder Request message for [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].StartEnvironmentResponse Message included in the response field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment] once the operation is complete.StartEnvironmentResponse.Builder Message included in the response field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment] once the operation is complete. -
Enum Summary Enum Description CloudShellErrorDetails.CloudShellErrorCode Set of possible errors returned from API calls.Environment.State Possible execution states for an environment.StartEnvironmentMetadata.State Possible states an environment might transition between during startup.