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

Interfaces

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.cloud.shell.v1.IAddPublicKeyMetadata

Properties of an AddPublicKeyMetadata.

protos.google.cloud.shell.v1.IAddPublicKeyRequest

Properties of an AddPublicKeyRequest.

protos.google.cloud.shell.v1.IAddPublicKeyResponse

Properties of an AddPublicKeyResponse.

protos.google.cloud.shell.v1.IAuthorizeEnvironmentMetadata

Properties of an AuthorizeEnvironmentMetadata.

protos.google.cloud.shell.v1.IAuthorizeEnvironmentRequest

Properties of an AuthorizeEnvironmentRequest.

protos.google.cloud.shell.v1.IAuthorizeEnvironmentResponse

Properties of an AuthorizeEnvironmentResponse.

protos.google.cloud.shell.v1.ICloudShellErrorDetails

Properties of a CloudShellErrorDetails.

protos.google.cloud.shell.v1.ICreateEnvironmentMetadata

Properties of a CreateEnvironmentMetadata.

protos.google.cloud.shell.v1.IDeleteEnvironmentMetadata

Properties of a DeleteEnvironmentMetadata.

protos.google.cloud.shell.v1.IEnvironment

Properties of an Environment.

protos.google.cloud.shell.v1.IGetEnvironmentRequest

Properties of a GetEnvironmentRequest.

protos.google.cloud.shell.v1.IRemovePublicKeyMetadata

Properties of a RemovePublicKeyMetadata.

protos.google.cloud.shell.v1.IRemovePublicKeyRequest

Properties of a RemovePublicKeyRequest.

protos.google.cloud.shell.v1.IRemovePublicKeyResponse

Properties of a RemovePublicKeyResponse.

protos.google.cloud.shell.v1.IStartEnvironmentMetadata

Properties of a StartEnvironmentMetadata.

protos.google.cloud.shell.v1.IStartEnvironmentRequest

Properties of a StartEnvironmentRequest.

protos.google.cloud.shell.v1.IStartEnvironmentResponse

Properties of a StartEnvironmentResponse.

protos.google.longrunning.ICancelOperationRequest

Properties of a CancelOperationRequest.

protos.google.longrunning.IDeleteOperationRequest

Properties of a DeleteOperationRequest.

protos.google.longrunning.IGetOperationRequest

Properties of a GetOperationRequest.

protos.google.longrunning.IListOperationsRequest

Properties of a ListOperationsRequest.

protos.google.longrunning.IListOperationsResponse

Properties of a ListOperationsResponse.

protos.google.longrunning.IOperation

Properties of an Operation.

protos.google.longrunning.IOperationInfo

Properties of an OperationInfo.

protos.google.longrunning.IWaitOperationRequest

Properties of a WaitOperationRequest.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.IStatus

Properties of a Status.

Enums

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.cloud.shell.v1.CloudShellErrorDetails.CloudShellErrorCode

CloudShellErrorCode enum.

protos.google.cloud.shell.v1.Environment.State

State enum.

protos.google.cloud.shell.v1.StartEnvironmentMetadata.State

State enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

Variables

_default

_default: {
    v1: typeof v1;
    CloudShellServiceClient: typeof v1.CloudShellServiceClient;
}

CloudShellServiceClient

CloudShellServiceClient: typeof v1.CloudShellServiceClient

Type Aliases

CloudShellServiceClient

declare type CloudShellServiceClient = v1.CloudShellServiceClient;

protos.google.cloud.shell.v1.CloudShellService.AddPublicKeyCallback

type AddPublicKeyCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.cloud.shell.v1.CloudShellService.AuthorizeEnvironmentCallback

type AuthorizeEnvironmentCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.cloud.shell.v1.CloudShellService.GetEnvironmentCallback

type GetEnvironmentCallback = (error: (Error|null), response?: google.cloud.shell.v1.Environment) => void;

Callback as used by .

protos.google.cloud.shell.v1.CloudShellService.RemovePublicKeyCallback

type RemovePublicKeyCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.cloud.shell.v1.CloudShellService.StartEnvironmentCallback

type StartEnvironmentCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.CancelOperationCallback

type CancelOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.DeleteOperationCallback

type DeleteOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.GetOperationCallback

type GetOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.ListOperationsCallback

type ListOperationsCallback = (error: (Error|null), response?: google.longrunning.ListOperationsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.WaitOperationCallback

type WaitOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .