Class protos.google.cloud.compute.v1.Routers (6.5.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

deleteRoutePolicy(request, callback)

public deleteRoutePolicy(request: google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest, callback: google.cloud.compute.v1.Routers.DeleteRoutePolicyCallback): void;

Calls DeleteRoutePolicy.

Parameters
Name Description
request IDeleteRoutePolicyRouterRequest

DeleteRoutePolicyRouterRequest message or plain object
callback DeleteRoutePolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteRoutePolicy(request)

public deleteRoutePolicy(request: google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DeleteRoutePolicy.

Parameter
Name Description
request IDeleteRoutePolicyRouterRequest

DeleteRoutePolicyRouterRequest 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

getRoutePolicy(request, callback)

public getRoutePolicy(request: google.cloud.compute.v1.IGetRoutePolicyRouterRequest, callback: google.cloud.compute.v1.Routers.GetRoutePolicyCallback): void;

Calls GetRoutePolicy.

Parameters
Name Description
request IGetRoutePolicyRouterRequest

GetRoutePolicyRouterRequest message or plain object
callback GetRoutePolicyCallback

Node-style callback called with the error, if any, and RoutersGetRoutePolicyResponse
Returns
Type Description
void

getRoutePolicy(request)

public getRoutePolicy(request: google.cloud.compute.v1.IGetRoutePolicyRouterRequest): Promise<google.cloud.compute.v1.RoutersGetRoutePolicyResponse>;

Calls GetRoutePolicy.

Parameter
Name Description
request IGetRoutePolicyRouterRequest

GetRoutePolicyRouterRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.RoutersGetRoutePolicyResponse>

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

listBgpRoutes(request, callback)

public listBgpRoutes(request: google.cloud.compute.v1.IListBgpRoutesRoutersRequest, callback: google.cloud.compute.v1.Routers.ListBgpRoutesCallback): void;

Calls ListBgpRoutes.

Parameters
Name Description
request IListBgpRoutesRoutersRequest

ListBgpRoutesRoutersRequest message or plain object
callback ListBgpRoutesCallback

Node-style callback called with the error, if any, and RoutersListBgpRoutes
Returns
Type Description
void

listBgpRoutes(request)

public listBgpRoutes(request: google.cloud.compute.v1.IListBgpRoutesRoutersRequest): Promise<google.cloud.compute.v1.RoutersListBgpRoutes>;

Calls ListBgpRoutes.

Parameter
Name Description
request IListBgpRoutesRoutersRequest

ListBgpRoutesRoutersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.RoutersListBgpRoutes>

Promise

listRoutePolicies(request, callback)

public listRoutePolicies(request: google.cloud.compute.v1.IListRoutePoliciesRoutersRequest, callback: google.cloud.compute.v1.Routers.ListRoutePoliciesCallback): void;

Calls ListRoutePolicies.

Parameters
Name Description
request IListRoutePoliciesRoutersRequest

ListRoutePoliciesRoutersRequest message or plain object
callback ListRoutePoliciesCallback

Node-style callback called with the error, if any, and RoutersListRoutePolicies
Returns
Type Description
void

listRoutePolicies(request)

public listRoutePolicies(request: google.cloud.compute.v1.IListRoutePoliciesRoutersRequest): Promise<google.cloud.compute.v1.RoutersListRoutePolicies>;

Calls ListRoutePolicies.

Parameter
Name Description
request IListRoutePoliciesRoutersRequest

ListRoutePoliciesRoutersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.RoutersListRoutePolicies>

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

patchRoutePolicy(request, callback)

public patchRoutePolicy(request: google.cloud.compute.v1.IPatchRoutePolicyRouterRequest, callback: google.cloud.compute.v1.Routers.PatchRoutePolicyCallback): void;

Calls PatchRoutePolicy.

Parameters
Name Description
request IPatchRoutePolicyRouterRequest

PatchRoutePolicyRouterRequest message or plain object
callback PatchRoutePolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

patchRoutePolicy(request)

public patchRoutePolicy(request: google.cloud.compute.v1.IPatchRoutePolicyRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls PatchRoutePolicy.

Parameter
Name Description
request IPatchRoutePolicyRouterRequest

PatchRoutePolicyRouterRequest 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

updateRoutePolicy(request, callback)

public updateRoutePolicy(request: google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest, callback: google.cloud.compute.v1.Routers.UpdateRoutePolicyCallback): void;

Calls UpdateRoutePolicy.

Parameters
Name Description
request IUpdateRoutePolicyRouterRequest

UpdateRoutePolicyRouterRequest message or plain object
callback UpdateRoutePolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateRoutePolicy(request)

public updateRoutePolicy(request: google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdateRoutePolicy.

Parameter
Name Description
request IUpdateRoutePolicyRouterRequest

UpdateRoutePolicyRouterRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise