Class protos.google.cloud.run.v2.Instances (3.2.0)

Version latest

• 3.2.0 (latest)
• 2.1.0
• 1.5.0
• 1.0.2
• 0.5.0
• 0.4.2
• 0.2.3

Represents an Instances

Inheritance

$protobuf.rpc.Service > protos.google.cloud.run.v2.Instances

Package

@google-cloud/run

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Instances service.

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

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new Instances 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
Instances	RPC service. Useful where requests and/or responses are streamed.

createInstance(request, callback)

public createInstance(request: google.cloud.run.v2.ICreateInstanceRequest, callback: google.cloud.run.v2.Instances.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name	Description
request	ICreateInstanceRequest CreateInstanceRequest message or plain object
callback	CreateInstanceCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createInstance(request)

public createInstance(request: google.cloud.run.v2.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name	Description
request	ICreateInstanceRequest CreateInstanceRequest message or plain object

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

deleteInstance(request, callback)

public deleteInstance(request: google.cloud.run.v2.IDeleteInstanceRequest, callback: google.cloud.run.v2.Instances.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name	Description
request	IDeleteInstanceRequest DeleteInstanceRequest message or plain object
callback	DeleteInstanceCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteInstance(request)

public deleteInstance(request: google.cloud.run.v2.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;

Calls DeleteInstance.

Parameter
Name	Description
request	IDeleteInstanceRequest DeleteInstanceRequest message or plain object

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

getInstance(request, callback)

public getInstance(request: google.cloud.run.v2.IGetInstanceRequest, callback: google.cloud.run.v2.Instances.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name	Description
request	IGetInstanceRequest GetInstanceRequest message or plain object
callback	GetInstanceCallback Node-style callback called with the error, if any, and Instance

Returns
Type	Description
void

getInstance(request)

public getInstance(request: google.cloud.run.v2.IGetInstanceRequest): Promise<google.cloud.run.v2.Instance>;

Calls GetInstance.

Parameter
Name	Description
request	IGetInstanceRequest GetInstanceRequest message or plain object

Returns
Type	Description
Promise<google.cloud.run.v2.Instance>	Promise

listInstances(request, callback)

public listInstances(request: google.cloud.run.v2.IListInstancesRequest, callback: google.cloud.run.v2.Instances.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name	Description
request	IListInstancesRequest ListInstancesRequest message or plain object
callback	ListInstancesCallback Node-style callback called with the error, if any, and ListInstancesResponse

Returns
Type	Description
void

listInstances(request)

public listInstances(request: google.cloud.run.v2.IListInstancesRequest): Promise<google.cloud.run.v2.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name	Description
request	IListInstancesRequest ListInstancesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.run.v2.ListInstancesResponse>	Promise

startInstance(request, callback)

public startInstance(request: google.cloud.run.v2.IStartInstanceRequest, callback: google.cloud.run.v2.Instances.StartInstanceCallback): void;

Calls StartInstance.

Parameters
Name	Description
request	IStartInstanceRequest StartInstanceRequest message or plain object
callback	StartInstanceCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

startInstance(request)

public startInstance(request: google.cloud.run.v2.IStartInstanceRequest): Promise<google.longrunning.Operation>;

Calls StartInstance.

Parameter
Name	Description
request	IStartInstanceRequest StartInstanceRequest message or plain object

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

stopInstance(request, callback)

public stopInstance(request: google.cloud.run.v2.IStopInstanceRequest, callback: google.cloud.run.v2.Instances.StopInstanceCallback): void;

Calls StopInstance.

Parameters
Name	Description
request	IStopInstanceRequest StopInstanceRequest message or plain object
callback	StopInstanceCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

stopInstance(request)

public stopInstance(request: google.cloud.run.v2.IStopInstanceRequest): Promise<google.longrunning.Operation>;

Calls StopInstance.

Parameter
Name	Description
request	IStopInstanceRequest StopInstanceRequest message or plain object

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