CloudShell

import { CloudShell } from "https://googleapis.deno.dev/v1/cloudshell:v1.ts";

Allows users to start, configure, and connect to interactive shell sessions running in the cloud.

class CloudShell {

constructor(client?: CredentialsClient, baseUrl?: string);

async operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async operationsDelete(name: string): Promise<Empty>;

async operationsGet(name: string): Promise<Operation>;

async operationsList(name: string, opts?: OperationsListOptions): Promise<ListOperationsResponse>;

async usersEnvironmentsAddPublicKey(environment: string, req: AddPublicKeyRequest): Promise<Operation>;

async usersEnvironmentsAuthorize(name: string, req: AuthorizeEnvironmentRequest): Promise<Operation>;

async usersEnvironmentsGet(name: string): Promise<Environment>;

async usersEnvironmentsRemovePublicKey(environment: string, req: RemovePublicKeyRequest): Promise<Operation>;

async usersEnvironmentsStart(name: string, req: StartEnvironmentRequest): Promise<Operation>;

}

§Constructors

new CloudShell(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

operationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

operationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

operationsList(name: string, opts?: OperationsListOptions): Promise<ListOperationsResponse>

[src]

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

@param name

The name of the operation's parent resource.

usersEnvironmentsAddPublicKey(environment: string, req: AddPublicKeyRequest): Promise<Operation>

[src]

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.

@param environment

Environment this key should be added to, e.g. users/me/environments/default.

usersEnvironmentsAuthorize(name: string, req: AuthorizeEnvironmentRequest): Promise<Operation>

[src]

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.

@param name

Name of the resource that should receive the credentials, for example users/me/environments/default or users/someone@example.com/environments/default.

usersEnvironmentsGet(name: string): Promise<Environment>

[src]

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

@param name

Required. Name of the requested resource, for example users/me/environments/default or users/someone@example.com/environments/default.

usersEnvironmentsRemovePublicKey(environment: string, req: RemovePublicKeyRequest): Promise<Operation>

[src]

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.

@param environment

Environment this key should be removed from, e.g. users/me/environments/default.

usersEnvironmentsStart(name: string, req: StartEnvironmentRequest): Promise<Operation>

[src]

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.

@param name

Name of the resource that should be started, for example users/me/environments/default or users/someone@example.com/environments/default.