| 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. |
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. |
Settings class to configure an instance of CloudShellServiceClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com. |
Message included in the metadata field of operations returned from AddPublicKey. |
| com. |
Message included in the metadata field of operations returned from AddPublicKey. |
| com. |
Request message for AddPublicKey. |
| com. |
Request message for AddPublicKey. |
| com. |
Response message for AddPublicKey. |
| com. |
Response message for AddPublicKey. |
| com. |
Message included in the metadata field of operations returned from AuthorizeEnvironment. |
| com. |
Message included in the metadata field of operations returned from AuthorizeEnvironment. |
| com. |
Request message for AuthorizeEnvironment. |
| com. |
Request message for AuthorizeEnvironment. |
| com. |
Response message for AuthorizeEnvironment. |
| com. |
Response message for AuthorizeEnvironment. |
| com. |
Cloud-shell specific information that will be included as details in failure responses. |
| com. |
Cloud-shell specific information that will be included as details in failure responses. |
| com. |
|
| com. |
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. |
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. |
Builder for CloudShellServiceSettings. |
| com. |
Message included in the metadata field of operations returned from CreateEnvironment. |
| com. |
Message included in the metadata field of operations returned from CreateEnvironment. |
| com. |
Message included in the metadata field of operations returned from DeleteEnvironment. |
| com. |
Message included in the metadata field of operations returned from DeleteEnvironment. |
| com. |
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. |
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. |
|
| com. |
Builder for users/{user}/environments/{environment}. |
| com. |
Request message for GetEnvironment. |
| com. |
Request message for GetEnvironment. |
| com. |
Message included in the metadata field of operations returned from RemovePublicKey. |
| com. |
Message included in the metadata field of operations returned from RemovePublicKey. |
| com. |
Request message for RemovePublicKey. |
| com. |
Request message for RemovePublicKey. |
| com. |
Response message for RemovePublicKey. |
| com. |
Response message for RemovePublicKey. |
| com. |
Message included in the metadata field of operations returned from StartEnvironment. |
| com. |
Message included in the metadata field of operations returned from StartEnvironment. |
| com. |
Request message for StartEnvironment. |
| com. |
Request message for StartEnvironment. |
| com. |
Message included in the response field of operations returned from StartEnvironment once the operation is complete. |
| com. |
Message included in the response field of operations returned from StartEnvironment once the operation is complete. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com. |
Set of possible errors returned from API calls. |
| com. |
Possible execution states for an environment. |
| com. |
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 |