Class protos.google.cloud.compute.v1.Routers (4.3.0)

Version latest

• 4.3.0 (latest)
• 4.1.0
• 3.9.1
• 3.8.1
• 3.6.0
• 3.5.1
• 3.1.2
• 3.0.0

Represents a Routers

Inheritance

$protobuf.rpc.Service > protos.google.cloud.compute.v1.Routers

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Routers service.

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

Methods

aggregatedList(request, callback)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListRoutersRequest, callback: google.cloud.compute.v1.Routers.AggregatedListCallback): void;

Calls AggregatedList.

Parameters
Name	Description
request	IAggregatedListRoutersRequest AggregatedListRoutersRequest message or plain object
callback	AggregatedListCallback Node-style callback called with the error, if any, and RouterAggregatedList

Returns
Type	Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListRoutersRequest): Promise<google.cloud.compute.v1.RouterAggregatedList>;

Calls AggregatedList.

Parameter
Name	Description
request	IAggregatedListRoutersRequest AggregatedListRoutersRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.RouterAggregatedList>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

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

delete(request, callback)

public delete(request: google.cloud.compute.v1.IDeleteRouterRequest, callback: google.cloud.compute.v1.Routers.DeleteCallback): void;

Calls Delete.

Parameters
Name	Description
request	IDeleteRouterRequest DeleteRouterRequest message or plain object
callback	DeleteCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

delete(request)

public delete(request: google.cloud.compute.v1.IDeleteRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name	Description
request	IDeleteRouterRequest DeleteRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.Operation>	Promise

get(request, callback)

public get(request: google.cloud.compute.v1.IGetRouterRequest, callback: google.cloud.compute.v1.Routers.GetCallback): void;

Calls Get.

Parameters
Name	Description
request	IGetRouterRequest GetRouterRequest message or plain object
callback	GetCallback Node-style callback called with the error, if any, and Router

Returns
Type	Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetRouterRequest): Promise<google.cloud.compute.v1.Router>;

Calls Get.

Parameter
Name	Description
request	IGetRouterRequest GetRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.Router>	Promise

getNatIpInfo(request, callback)

public getNatIpInfo(request: google.cloud.compute.v1.IGetNatIpInfoRouterRequest, callback: google.cloud.compute.v1.Routers.GetNatIpInfoCallback): void;

Calls GetNatIpInfo.

Parameters
Name	Description
request	IGetNatIpInfoRouterRequest GetNatIpInfoRouterRequest message or plain object
callback	GetNatIpInfoCallback Node-style callback called with the error, if any, and NatIpInfoResponse

Returns
Type	Description
void

getNatIpInfo(request)

public getNatIpInfo(request: google.cloud.compute.v1.IGetNatIpInfoRouterRequest): Promise<google.cloud.compute.v1.NatIpInfoResponse>;

Calls GetNatIpInfo.

Parameter
Name	Description
request	IGetNatIpInfoRouterRequest GetNatIpInfoRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.NatIpInfoResponse>	Promise

getNatMappingInfo(request, callback)

public getNatMappingInfo(request: google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest, callback: google.cloud.compute.v1.Routers.GetNatMappingInfoCallback): void;

Calls GetNatMappingInfo.

Parameters
Name	Description
request	IGetNatMappingInfoRoutersRequest GetNatMappingInfoRoutersRequest message or plain object
callback	GetNatMappingInfoCallback Node-style callback called with the error, if any, and VmEndpointNatMappingsList

Returns
Type	Description
void

getNatMappingInfo(request)

public getNatMappingInfo(request: google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest): Promise<google.cloud.compute.v1.VmEndpointNatMappingsList>;

Calls GetNatMappingInfo.

Parameter
Name	Description
request	IGetNatMappingInfoRoutersRequest GetNatMappingInfoRoutersRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.VmEndpointNatMappingsList>	Promise

getRouterStatus(request, callback)

public getRouterStatus(request: google.cloud.compute.v1.IGetRouterStatusRouterRequest, callback: google.cloud.compute.v1.Routers.GetRouterStatusCallback): void;

Calls GetRouterStatus.

Parameters
Name	Description
request	IGetRouterStatusRouterRequest GetRouterStatusRouterRequest message or plain object
callback	GetRouterStatusCallback Node-style callback called with the error, if any, and RouterStatusResponse

Returns
Type	Description
void

getRouterStatus(request)

public getRouterStatus(request: google.cloud.compute.v1.IGetRouterStatusRouterRequest): Promise<google.cloud.compute.v1.RouterStatusResponse>;

Calls GetRouterStatus.

Parameter
Name	Description
request	IGetRouterStatusRouterRequest GetRouterStatusRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.RouterStatusResponse>	Promise

insert(request, callback)

public insert(request: google.cloud.compute.v1.IInsertRouterRequest, callback: google.cloud.compute.v1.Routers.InsertCallback): void;

Calls Insert.

Parameters
Name	Description
request	IInsertRouterRequest InsertRouterRequest message or plain object
callback	InsertCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

insert(request)

public insert(request: google.cloud.compute.v1.IInsertRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name	Description
request	IInsertRouterRequest InsertRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.Operation>	Promise

list(request, callback)

public list(request: google.cloud.compute.v1.IListRoutersRequest, callback: google.cloud.compute.v1.Routers.ListCallback): void;

Calls List.

Parameters
Name	Description
request	IListRoutersRequest ListRoutersRequest message or plain object
callback	ListCallback Node-style callback called with the error, if any, and RouterList

Returns
Type	Description
void

list(request)

public list(request: google.cloud.compute.v1.IListRoutersRequest): Promise<google.cloud.compute.v1.RouterList>;

Calls List.

Parameter
Name	Description
request	IListRoutersRequest ListRoutersRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.RouterList>	Promise

patch(request, callback)

public patch(request: google.cloud.compute.v1.IPatchRouterRequest, callback: google.cloud.compute.v1.Routers.PatchCallback): void;

Calls Patch.

Parameters
Name	Description
request	IPatchRouterRequest PatchRouterRequest message or plain object
callback	PatchCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

patch(request)

public patch(request: google.cloud.compute.v1.IPatchRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Patch.

Parameter
Name	Description
request	IPatchRouterRequest PatchRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.Operation>	Promise

preview(request, callback)

public preview(request: google.cloud.compute.v1.IPreviewRouterRequest, callback: google.cloud.compute.v1.Routers.PreviewCallback): void;

Calls Preview.

Parameters
Name	Description
request	IPreviewRouterRequest PreviewRouterRequest message or plain object
callback	PreviewCallback Node-style callback called with the error, if any, and RoutersPreviewResponse

Returns
Type	Description
void

preview(request)

public preview(request: google.cloud.compute.v1.IPreviewRouterRequest): Promise<google.cloud.compute.v1.RoutersPreviewResponse>;

Calls Preview.

Parameter
Name	Description
request	IPreviewRouterRequest PreviewRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.RoutersPreviewResponse>	Promise

update(request, callback)

public update(request: google.cloud.compute.v1.IUpdateRouterRequest, callback: google.cloud.compute.v1.Routers.UpdateCallback): void;

Calls Update.

Parameters
Name	Description
request	IUpdateRouterRequest UpdateRouterRequest message or plain object
callback	UpdateCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

update(request)

public update(request: google.cloud.compute.v1.IUpdateRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Update.

Parameter
Name	Description
request	IUpdateRouterRequest UpdateRouterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.compute.v1.Operation>	Promise