Namespace Google.Cloud.Shell.V1 (2.0.0)

Classes

AddPublicKeyMetadata

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].

AddPublicKeyResponse

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].

AuthorizeEnvironmentRequest

Request message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].

AuthorizeEnvironmentResponse

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.Types

Container for nested types declared in the CloudShellErrorDetails message type.

CloudShellService

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.

CloudShellService.CloudShellServiceBase

Base class for server-side implementations of CloudShellService

CloudShellService.CloudShellServiceClient

Client for CloudShellService

CloudShellServiceClient

CloudShellService client wrapper, for convenient use.

CloudShellServiceClientBuilder

Builder class for CloudShellServiceClient to provide simple configuration of credentials, endpoint etc.

CloudShellServiceClientImpl

CloudShellService client wrapper implementation, for convenient use.

CloudShellServiceSettings

Settings for CloudShellServiceClient instances.

CreateEnvironmentMetadata

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].

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 at least an environment with the ID "default".

Environment.Types

Container for nested types declared in the Environment message type.

EnvironmentName

Resource name for the Environment resource.

GetEnvironmentRequest

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].

RemovePublicKeyRequest

Request message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].

RemovePublicKeyResponse

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.Types

Container for nested types declared in the StartEnvironmentMetadata message type.

StartEnvironmentRequest

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.

Enums

CloudShellErrorDetails.Types.CloudShellErrorCode

Set of possible errors returned from API calls.

Environment.Types.State

Possible execution states for an environment.

EnvironmentName.ResourceNameType

The possible contents of EnvironmentName.

StartEnvironmentMetadata.Types.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 through all of these states when starting. More states are likely to be added in the future.