Show / Hide Table of Contents

Namespace Google.Apis.CloudShell.v1

Classes

CloudShellBaseServiceRequest<TResponse>

A base abstract class for CloudShell requests.

CloudShellService

The CloudShell Service.

CloudShellService.Scope

Available OAuth 2.0 scopes for use with the Cloud Shell API.

CloudShellService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Shell API.

OperationsResource

The "operations" collection of methods.

OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

OperationsResource.DeleteRequest

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

UsersResource

The "users" collection of methods.

UsersResource.EnvironmentsResource

The "environments" collection of methods.

UsersResource.EnvironmentsResource.AddPublicKeyRequest

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

UsersResource.EnvironmentsResource.AuthorizeRequest

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

UsersResource.EnvironmentsResource.GetRequest

Gets an environment. Returns NOT_FOUND if the environment does not exist.

UsersResource.EnvironmentsResource.RemovePublicKeyRequest

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

UsersResource.EnvironmentsResource.StartRequest

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

Enums

CloudShellBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudShellBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In this article
Back to top Generated by DocFX