Package Classes (1.13.0)

Summary of entries of Classes for cloudshell.

Classes

CloudShellServiceAsyncClient

API for interacting with Google Cloud Shell. Each user ofCloud Shell has at least one environment, which has the ID"default". Environment consists of a Docker image defining whatis installed on the environment and a home directory containingthe user's data that will remain across sessions. Clients usethis API to start and fetch information about their environment,which can then be used to connect to that environment via aseparate SSH client.

CloudShellServiceClient

API for interacting with Google Cloud Shell. Each user ofCloud Shell has at least one environment, which has the ID"default". Environment consists of a Docker image defining whatis installed on the environment and a home directory containingthe user's data that will remain across sessions. Clients usethis API to start and fetch information about their environment,which can then be used to connect to that environment via aseparate SSH client.

AddPublicKeyMetadata

Message included in the metadata field of operations returned fromAddPublicKey.

AddPublicKeyRequest

Request message forAddPublicKey.

AddPublicKeyResponse

Response message forAddPublicKey.

AuthorizeEnvironmentMetadata

Message included in the metadata field of operations returned fromAuthorizeEnvironment.

AuthorizeEnvironmentRequest

Request message forAuthorizeEnvironment.

AuthorizeEnvironmentResponse

Response message forAuthorizeEnvironment.

CloudShellErrorDetails

Cloud-shell specific information that will be included asdetails in failure responses.

CloudShellErrorCode

Set of possible errors returned from API calls.

CreateEnvironmentMetadata

Message included in the metadata field of operations returned fromCreateEnvironment.

DeleteEnvironmentMetadata

Message included in the metadata field of operations returned fromDeleteEnvironment.

Environment

A Cloud Shell environment, which is defined as thecombination of a Docker image specifying what is installed onthe environment and a home directory containing the user's datathat will remain across sessions. Each user has at least anenvironment with the ID "default".

State

Possible execution states for an environment.

GetEnvironmentRequest

Request message forGetEnvironment.

RemovePublicKeyMetadata

Message included in the metadata field of operations returned fromRemovePublicKey.

RemovePublicKeyRequest

Request message forRemovePublicKey.

RemovePublicKeyResponse

Response message forRemovePublicKey.

StartEnvironmentMetadata

Message included in the metadata field of operations returned fromStartEnvironment.

State

Possible states an environment might transition betweenduring startup. These states are not normally actionable byclients, but may be used to show a progress message to the user.An environment won't necessarily go through all of these stateswhen starting. More states are likely to be added in the future.

StartEnvironmentRequest

Request message forStartEnvironment.

StartEnvironmentResponse

Message included in the response field of operations returned fromStartEnvironmentonce the operation is complete.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.