Class protos.google.cloud.shell.v1.CloudShellService (2.1.2)

Version latest

• 2.1.2 (latest)
• 2.1.1
• 2.0.4
• 1.0.5

Represents a CloudShellService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.shell.v1.CloudShellService

Package

@google-cloud/shell

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CloudShellService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

addPublicKey(request, callback)

public addPublicKey(request: google.cloud.shell.v1.IAddPublicKeyRequest, callback: google.cloud.shell.v1.CloudShellService.AddPublicKeyCallback): void;

Calls AddPublicKey.

Parameters
Name	Description
request	google.cloud.shell.v1.IAddPublicKeyRequest AddPublicKeyRequest message or plain object
callback	google.cloud.shell.v1.CloudShellService.AddPublicKeyCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

addPublicKey(request)

public addPublicKey(request: google.cloud.shell.v1.IAddPublicKeyRequest): Promise<google.longrunning.Operation>;

Calls AddPublicKey.

Parameter
Name	Description
request	google.cloud.shell.v1.IAddPublicKeyRequest AddPublicKeyRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

authorizeEnvironment(request, callback)

public authorizeEnvironment(request: google.cloud.shell.v1.IAuthorizeEnvironmentRequest, callback: google.cloud.shell.v1.CloudShellService.AuthorizeEnvironmentCallback): void;

Calls AuthorizeEnvironment.

Parameters
Name	Description
request	google.cloud.shell.v1.IAuthorizeEnvironmentRequest AuthorizeEnvironmentRequest message or plain object
callback	google.cloud.shell.v1.CloudShellService.AuthorizeEnvironmentCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

authorizeEnvironment(request)

public authorizeEnvironment(request: google.cloud.shell.v1.IAuthorizeEnvironmentRequest): Promise<google.longrunning.Operation>;

Calls AuthorizeEnvironment.

Parameter
Name	Description
request	google.cloud.shell.v1.IAuthorizeEnvironmentRequest AuthorizeEnvironmentRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudShellService;

Creates new CloudShellService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
CloudShellService	RPC service. Useful where requests and/or responses are streamed.

getEnvironment(request, callback)

public getEnvironment(request: google.cloud.shell.v1.IGetEnvironmentRequest, callback: google.cloud.shell.v1.CloudShellService.GetEnvironmentCallback): void;

Calls GetEnvironment.

Parameters
Name	Description
request	google.cloud.shell.v1.IGetEnvironmentRequest GetEnvironmentRequest message or plain object
callback	google.cloud.shell.v1.CloudShellService.GetEnvironmentCallback Node-style callback called with the error, if any, and Environment

Returns
Type	Description
void

getEnvironment(request)

public getEnvironment(request: google.cloud.shell.v1.IGetEnvironmentRequest): Promise<google.cloud.shell.v1.Environment>;

Calls GetEnvironment.

Parameter
Name	Description
request	google.cloud.shell.v1.IGetEnvironmentRequest GetEnvironmentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.shell.v1.Environment>	Promise

removePublicKey(request, callback)

public removePublicKey(request: google.cloud.shell.v1.IRemovePublicKeyRequest, callback: google.cloud.shell.v1.CloudShellService.RemovePublicKeyCallback): void;

Calls RemovePublicKey.

Parameters
Name	Description
request	google.cloud.shell.v1.IRemovePublicKeyRequest RemovePublicKeyRequest message or plain object
callback	google.cloud.shell.v1.CloudShellService.RemovePublicKeyCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

removePublicKey(request)

public removePublicKey(request: google.cloud.shell.v1.IRemovePublicKeyRequest): Promise<google.longrunning.Operation>;

Calls RemovePublicKey.

Parameter
Name	Description
request	google.cloud.shell.v1.IRemovePublicKeyRequest RemovePublicKeyRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

startEnvironment(request, callback)

public startEnvironment(request: google.cloud.shell.v1.IStartEnvironmentRequest, callback: google.cloud.shell.v1.CloudShellService.StartEnvironmentCallback): void;

Calls StartEnvironment.

Parameters
Name	Description
request	google.cloud.shell.v1.IStartEnvironmentRequest StartEnvironmentRequest message or plain object
callback	google.cloud.shell.v1.CloudShellService.StartEnvironmentCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

startEnvironment(request)

public startEnvironment(request: google.cloud.shell.v1.IStartEnvironmentRequest): Promise<google.longrunning.Operation>;

Calls StartEnvironment.

Parameter
Name	Description
request	google.cloud.shell.v1.IStartEnvironmentRequest StartEnvironmentRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise