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.
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.
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 at least an
environment with the ID "default".
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 through all of these states
when starting. More states are likely to be added in the future.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Package Classes (1.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.12.0 (latest)](/python/docs/reference/cloudshell/latest/summary_class)\n- [1.11.0](/python/docs/reference/cloudshell/1.11.0/summary_class)\n- [1.10.1](/python/docs/reference/cloudshell/1.10.1/summary_class)\n- [1.9.5](/python/docs/reference/cloudshell/1.9.5/summary_class)\n- [1.8.0](/python/docs/reference/cloudshell/1.8.0/summary_class)\n- [1.7.2](/python/docs/reference/cloudshell/1.7.2/summary_class)\n- [1.6.1](/python/docs/reference/cloudshell/1.6.1/summary_class)\n- [1.5.0](/python/docs/reference/cloudshell/1.5.0/summary_class)\n- [1.4.3](/python/docs/reference/cloudshell/1.4.3/summary_class)\n- [1.3.3](/python/docs/reference/cloudshell/1.3.3/summary_class)\n- [1.2.2](/python/docs/reference/cloudshell/1.2.2/summary_class)\n- [1.1.0](/python/docs/reference/cloudshell/1.1.0/summary_class)\n- [1.0.1](/python/docs/reference/cloudshell/1.0.1/summary_class)\n- [0.2.2](/python/docs/reference/cloudshell/0.2.2/summary_class)\n- [0.1.0](/python/docs/reference/cloudshell/0.1.0/summary_class) \nSummary of entries of Classes for cloudshell. \n\nClasses\n-------\n\n### [CloudShellServiceAsyncClient](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient)\n\nAPI for interacting with Google Cloud Shell. Each user of\nCloud Shell has at least one environment, which has the ID\n\"default\". Environment consists of a Docker image defining what\nis installed on the environment and a home directory containing\nthe user's data that will remain across sessions. Clients use\nthis API to start and fetch information about their environment,\nwhich can then be used to connect to that environment via a\nseparate SSH client.\n\n### [CloudShellServiceClient](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient)\n\nAPI for interacting with Google Cloud Shell. Each user of\nCloud Shell has at least one environment, which has the ID\n\"default\". Environment consists of a Docker image defining what\nis installed on the environment and a home directory containing\nthe user's data that will remain across sessions. Clients use\nthis API to start and fetch information about their environment,\nwhich can then be used to connect to that environment via a\nseparate SSH client.\n\n### [AddPublicKeyMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AddPublicKeyMetadata)\n\nMessage included in the metadata field of operations returned from\nAddPublicKey.\n\n### [AddPublicKeyRequest](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AddPublicKeyRequest)\n\nRequest message for\nAddPublicKey.\n\n### [AddPublicKeyResponse](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AddPublicKeyResponse)\n\nResponse message for\nAddPublicKey.\n\n### [AuthorizeEnvironmentMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AuthorizeEnvironmentMetadata)\n\nMessage included in the metadata field of operations returned from\nAuthorizeEnvironment.\n\n### [AuthorizeEnvironmentRequest](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AuthorizeEnvironmentRequest)\n\nRequest message for\nAuthorizeEnvironment.\n\n### [AuthorizeEnvironmentResponse](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.AuthorizeEnvironmentResponse)\n\nResponse message for\nAuthorizeEnvironment.\n\n### [CloudShellErrorDetails](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.CloudShellErrorDetails)\n\nCloud-shell specific information that will be included as\ndetails in failure responses.\n\n### [CloudShellErrorCode](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.CloudShellErrorDetails.CloudShellErrorCode)\n\nSet of possible errors returned from API calls.\n\n### [CreateEnvironmentMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.CreateEnvironmentMetadata)\n\nMessage included in the metadata field of operations returned from\nCreateEnvironment.\n\n### [DeleteEnvironmentMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.DeleteEnvironmentMetadata)\n\nMessage included in the metadata field of operations returned from\nDeleteEnvironment.\n\n### [Environment](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.Environment)\n\nA Cloud Shell environment, which is defined as the\ncombination of a Docker image specifying what is installed on\nthe environment and a home directory containing the user's data\nthat will remain across sessions. Each user has at least an\nenvironment with the ID \"default\".\n\n### [State](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.Environment.State)\n\nPossible execution states for an environment.\n\n### [GetEnvironmentRequest](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.GetEnvironmentRequest)\n\nRequest message for\nGetEnvironment.\n\n### [RemovePublicKeyMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.RemovePublicKeyMetadata)\n\nMessage included in the metadata field of operations returned from\nRemovePublicKey.\n\n### [RemovePublicKeyRequest](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.RemovePublicKeyRequest)\n\nRequest message for\nRemovePublicKey.\n\n### [RemovePublicKeyResponse](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.RemovePublicKeyResponse)\n\nResponse message for\nRemovePublicKey.\n\n### [StartEnvironmentMetadata](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.StartEnvironmentMetadata)\n\nMessage included in the metadata field of operations returned from\nStartEnvironment.\n\n### [State](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.StartEnvironmentMetadata.State)\n\nPossible states an environment might transition between\nduring startup. These states are not normally actionable by\nclients, but may be used to show a progress message to the user.\nAn environment won't necessarily go through all of these states\nwhen starting. More states are likely to be added in the future.\n\n### [StartEnvironmentRequest](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.StartEnvironmentRequest)\n\nRequest message for\nStartEnvironment.\n\n### [StartEnvironmentResponse](/python/docs/reference/cloudshell/latest/google.cloud.shell_v1.types.StartEnvironmentResponse)\n\nMessage included in the response field of operations returned from\nStartEnvironment\nonce the operation is complete."]]
