Class v1.RoutersClient (6.5.0)

The Routers API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);

Construct an instance of RoutersClient.

Parameters
NameDescription
optsClientOptions
gaxInstancetypeofgax | typeoffallback

: loaded instance ofgoogle-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new RoutersClient({fallback: true}, gax); ```

Properties

apiEndpoint

getapiEndpoint():string;

The DNS address for this API service.

apiEndpoint

staticgetapiEndpoint():string;

The DNS address for this API service - same as servicePath.

auth

auth:gax.GoogleAuth;

descriptors

descriptors:Descriptors;

innerApiCalls

innerApiCalls:{[name:string]:Function;};

port

staticgetport():number;

The port for this API service.

routersStub

routersStub?:Promise<{[name:string]:Function;}>;

scopes

staticgetscopes():string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

staticgetservicePath():string;

The DNS address for this API service.

universeDomain

getuniverseDomain():string;

warn

warn:(code:string,message:string,warnType?:string)=>void;

Methods

aggregatedListAsync(request, options)

aggregatedListAsync(request?:protos.google.cloud.compute.v1.IAggregatedListRoutersRequest,options?:CallOptions):AsyncIterable<[string,protos.google.cloud.compute.v1.IRoutersScopedList]>;

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set thereturnPartialSuccess parameter totrue.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIAggregatedListRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<[string,protos.google.cloud.compute.v1.IRoutersScopedList]>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string,RoutersScopedList]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use:
 labels.owner:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included./// const includeAllScopes = true/*
  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)/// const maxResults = 1234/*
  • Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • Project ID for this request./// const project = 'my-project'/*
  • Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
  • The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.*/// const serviceProjectNumber = 1234

    // Imports the Compute libraryconst {RoutersClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new RoutersClient();

    async function callAggregatedList() {// Construct requestconst request = {project,};

    // Run requestconst iterable = computeClient.aggregatedListAsync(request);for await (const [key, value] of iterable) { console.log(response);}}

    callAggregatedList();

close()

close():Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

delete(request, options)

delete(request?:protos.google.cloud.compute.v1.IDeleteRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Deletes the specified Router resource.

Parameters
NameDescription
requestIDeleteRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Name of the Router resource to delete.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallDelete(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();

delete(request, options, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteRoutePolicy(request, options)

deleteRoutePolicy(request?:protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Deletes Route Policy

Parameters
NameDescription
requestIDeleteRoutePolicyRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  The Policy name for this request. Name must conform to RFC1035   */// const policy = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Name of the Router resource where Route Policy is defined.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallDeleteRoutePolicy(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.deleteRoutePolicy(request);console.log(response);}callDeleteRoutePolicy();

deleteRoutePolicy(request, options, callback)

deleteRoutePolicy(request:protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRoutePolicyRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteRoutePolicy(request, callback)

deleteRoutePolicy(request:protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRoutePolicyRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

get(request?:protos.google.cloud.compute.v1.IGetRouterRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest|undefined,{}|undefined]>;

Returns the specified Router resource.

Parameters
NameDescription
requestIGetRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRouter. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  Name of the Router resource to return.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallGet(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();

get(request, options, callback)

get(request:protos.google.cloud.compute.v1.IGetRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request:protos.google.cloud.compute.v1.IGetRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IRouter,protos.google.cloud.compute.v1.IGetRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNatIpInfo(request, options)

getNatIpInfo(request?:protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest|undefined,{}|undefined]>;

Retrieves runtime NAT IP information.

Parameters
NameDescription
requestIGetNatIpInfoRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingNatIpInfoResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.   */// const natName = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallGetNatIpInfo(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.getNatIpInfo(request);console.log(response);}callGetNatIpInfo();

getNatIpInfo(request, options, callback)

getNatIpInfo(request:protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetNatIpInfoRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNatIpInfo(request, callback)

getNatIpInfo(request:protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest,callback:Callback<protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetNatIpInfoRouterRequest
callbackCallback<protos.google.cloud.compute.v1.INatIpInfoResponse,protos.google.cloud.compute.v1.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNatMappingInfo(request, options)

getNatMappingInfo(request?:protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IVmEndpointNatMappings[],protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest|null,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList]>;

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
NameDescription
requestIGetNatMappingInfoRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IVmEndpointNatMappings[],protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest | null,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofVmEndpointNatMappings. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinggetNatMappingInfoAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

getNatMappingInfo(request, options, callback)

getNatMappingInfo(request:protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList|null|undefined,protos.google.cloud.compute.v1.IVmEndpointNatMappings>):void;
Parameters
NameDescription
requestIGetNatMappingInfoRoutersRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList | null | undefined,protos.google.cloud.compute.v1.IVmEndpointNatMappings>
Returns
TypeDescription
void

getNatMappingInfo(request, callback)

getNatMappingInfo(request:protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList|null|undefined,protos.google.cloud.compute.v1.IVmEndpointNatMappings>):void;
Parameters
NameDescription
requestIGetNatMappingInfoRoutersRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,protos.google.cloud.compute.v1.IVmEndpointNatMappingsList | null | undefined,protos.google.cloud.compute.v1.IVmEndpointNatMappings>
Returns
TypeDescription
void

getNatMappingInfoAsync(request, options)

getNatMappingInfoAsync(request?:protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IVmEndpointNatMappings>;

Equivalent togetNatMappingInfo, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIGetNatMappingInfoRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IVmEndpointNatMappings>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingVmEndpointNatMappings. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use:
 labels.owner:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)/// const maxResults = 1234/*
  • Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035./// const natName = 'abc123'/*
  • Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • Project ID for this request./// const project = 'my-project'/*
  • Name of the region for this request./// const region = 'us-central1'/*
  • Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
  • Name of the Router resource to query for Nat Mapping information of VM endpoints.*/// const router = 'abc123'

    // Imports the Compute libraryconst {RoutersClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new RoutersClient();

    async function callGetNatMappingInfo() {// Construct requestconst request = {project,region,router,};

    // Run requestconst iterable = computeClient.getNatMappingInfoAsync(request);for await (const response of iterable) { console.log(response);}}

    callGetNatMappingInfo();

getNatMappingInfoStream(request, options)

getNatMappingInfoStream(request?:protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest,options?:CallOptions):Transform;

Equivalent togetNatMappingInfo, but returns a NodeJS Stream object.

Parameters
NameDescription
requestIGetNatMappingInfoRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingVmEndpointNatMappings on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinggetNatMappingInfoAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

getProjectId()

getProjectId():Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;
Parameter
NameDescription
callbackCallback<string, undefined, undefined>
Returns
TypeDescription
void

getRoutePolicy(request, options)

getRoutePolicy(request?:protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest|undefined,{}|undefined]>;

Returns specified Route Policy

Parameters
NameDescription
requestIGetRoutePolicyRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRoutersGetRoutePolicyResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  The Policy name for this request. Name must conform to RFC1035   */// const policy = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  Name of the Router resource to query for the route policy. The name should conform to RFC1035.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallGetRoutePolicy(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.getRoutePolicy(request);console.log(response);}callGetRoutePolicy();

getRoutePolicy(request, options, callback)

getRoutePolicy(request:protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRoutePolicyRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRoutePolicy(request, callback)

getRoutePolicy(request:protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRoutePolicyRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IRoutersGetRoutePolicyResponse,protos.google.cloud.compute.v1.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRouterStatus(request, options)

getRouterStatus(request?:protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest|undefined,{}|undefined]>;

Retrieves runtime information of the specified router.

Parameters
NameDescription
requestIGetRouterStatusRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRouterStatusResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  Name of the Router resource to query.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallGetRouterStatus(){// Construct requestconstrequest={project,region,router,};// Run requestconstresponse=awaitcomputeClient.getRouterStatus(request);console.log(response);}callGetRouterStatus();

getRouterStatus(request, options, callback)

getRouterStatus(request:protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRouterStatusRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRouterStatus(request, callback)

getRouterStatus(request:protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRouterStatusRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IRouterStatusResponse,protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

initialize():Promise<{[name:string]:Function;}>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]:Function; }>

{Promise} A promise that resolves to an authenticated service stub.

insert(request, options)

insert(request?:protos.google.cloud.compute.v1.IInsertRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Creates a Router resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestIInsertRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  The body resource for this request   */// const routerResource = {}// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallInsert(){// Construct requestconstrequest={project,region,routerResource,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();

insert(request, options, callback)

insert(request:protos.google.cloud.compute.v1.IInsertRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIInsertRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

insert(request, callback)

insert(request:protos.google.cloud.compute.v1.IInsertRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIInsertRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

list(request, options)

list(request?:protos.google.cloud.compute.v1.IListRoutersRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRouter[],protos.google.cloud.compute.v1.IListRoutersRequest|null,protos.google.cloud.compute.v1.IRouterList]>;

Retrieves a list of Router resources available to the specified project.

Parameters
NameDescription
requestIListRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRouter[],protos.google.cloud.compute.v1.IListRoutersRequest | null,protos.google.cloud.compute.v1.IRouterList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofRouter. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

list(request, options, callback)

list(request:protos.google.cloud.compute.v1.IListRoutersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRoutersRequest,protos.google.cloud.compute.v1.IRouterList|null|undefined,protos.google.cloud.compute.v1.IRouter>):void;
Parameters
NameDescription
requestIListRoutersRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRoutersRequest,protos.google.cloud.compute.v1.IRouterList | null | undefined,protos.google.cloud.compute.v1.IRouter>
Returns
TypeDescription
void

list(request, callback)

list(request:protos.google.cloud.compute.v1.IListRoutersRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRoutersRequest,protos.google.cloud.compute.v1.IRouterList|null|undefined,protos.google.cloud.compute.v1.IRouter>):void;
Parameters
NameDescription
requestIListRoutersRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRoutersRequest,protos.google.cloud.compute.v1.IRouterList | null | undefined,protos.google.cloud.compute.v1.IRouter>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?:protos.google.cloud.compute.v1.IListRoutersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IRouter>;

Equivalent tolist, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IRouter>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingRouter. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use:
 labels.owner:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)/// const maxResults = 1234/*
  • Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • Project ID for this request./// const project = 'my-project'/*
  • Name of the region for this request./// const region = 'us-central1'/*
  • Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.*/// const returnPartialSuccess = true

    // Imports the Compute libraryconst {RoutersClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new RoutersClient();

    async function callList() {// Construct requestconst request = {project,region,};

    // Run requestconst iterable = computeClient.listAsync(request);for await (const response of iterable) { console.log(response);}}

    callList();

listBgpRoutes(request, options)

listBgpRoutes(request?:protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBgpRoute[],protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest|null,protos.google.cloud.compute.v1.IRoutersListBgpRoutes]>;

Retrieves a list of router bgp routes available to the specified project.

Parameters
NameDescription
requestIListBgpRoutesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IBgpRoute[],protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest | null,protos.google.cloud.compute.v1.IRoutersListBgpRoutes ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistBgpRoutesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listBgpRoutes(request, options, callback)

listBgpRoutes(request:protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListBgpRoutes|null|undefined,protos.google.cloud.compute.v1.IBgpRoute>):void;
Parameters
NameDescription
requestIListBgpRoutesRoutersRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListBgpRoutes | null | undefined,protos.google.cloud.compute.v1.IBgpRoute>
Returns
TypeDescription
void

listBgpRoutes(request, callback)

listBgpRoutes(request:protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListBgpRoutes|null|undefined,protos.google.cloud.compute.v1.IBgpRoute>):void;
Parameters
NameDescription
requestIListBgpRoutesRoutersRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListBgpRoutes | null | undefined,protos.google.cloud.compute.v1.IBgpRoute>
Returns
TypeDescription
void

listBgpRoutesAsync(request, options)

listBgpRoutesAsync(request?:protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IBgpRoute>;

Equivalent tolistBgpRoutes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListBgpRoutesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IBgpRoute>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  (Required) limit results to this address family (either IPv4 or IPv6)   *  Check the AddressFamily enum for the list of possible values.   */// const addressFamily = 'abc123'/**   *  Limit results to destinations that are subnets of this CIDR range   */// const destinationPrefix = 'abc123'/***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use:
 labels.owner:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)/// const maxResults = 1234/*
  • Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035./// const peer = 'abc123'/*
  • When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes./// const policyApplied = true/*
  • Project ID for this request./// const project = 'my-project'/*
  • Name of the region for this request./// const region = 'us-central1'/*
  • Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
  • (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  • Check the RouteType enum for the list of possible values./// const routeType = 'abc123'/*
  • Name or id of the resource for this request. Name should conform to RFC1035.*/// const router = 'abc123'

    // Imports the Compute libraryconst {RoutersClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new RoutersClient();

    async function callListBgpRoutes() {// Construct requestconst request = {project,region,router,};

    // Run requestconst iterable = computeClient.listBgpRoutesAsync(request);for await (const response of iterable) { console.log(response);}}

    callListBgpRoutes();

listBgpRoutesStream(request, options)

listBgpRoutesStream(request?:protos.google.cloud.compute.v1.IListBgpRoutesRoutersRequest,options?:CallOptions):Transform;

Equivalent tolistBgpRoutes, but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListBgpRoutesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistBgpRoutesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listRoutePolicies(request, options)

listRoutePolicies(request?:protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRoutePolicy[],protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest|null,protos.google.cloud.compute.v1.IRoutersListRoutePolicies]>;

Retrieves a list of router route policy subresources available to the specified project.

Parameters
NameDescription
requestIListRoutePoliciesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRoutePolicy[],protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest | null,protos.google.cloud.compute.v1.IRoutersListRoutePolicies ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistRoutePoliciesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listRoutePolicies(request, options, callback)

listRoutePolicies(request:protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListRoutePolicies|null|undefined,protos.google.cloud.compute.v1.IRoutePolicy>):void;
Parameters
NameDescription
requestIListRoutePoliciesRoutersRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListRoutePolicies | null | undefined,protos.google.cloud.compute.v1.IRoutePolicy>
Returns
TypeDescription
void

listRoutePolicies(request, callback)

listRoutePolicies(request:protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListRoutePolicies|null|undefined,protos.google.cloud.compute.v1.IRoutePolicy>):void;
Parameters
NameDescription
requestIListRoutePoliciesRoutersRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,protos.google.cloud.compute.v1.IRoutersListRoutePolicies | null | undefined,protos.google.cloud.compute.v1.IRoutePolicy>
Returns
TypeDescription
void

listRoutePoliciesAsync(request, options)

listRoutePoliciesAsync(request?:protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IRoutePolicy>;

Equivalent tolistRoutePolicies, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListRoutePoliciesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IRoutePolicy>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use:
 labels.owner:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)/// const maxResults = 1234/*
  • Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • Project ID for this request./// const project = 'my-project'/*
  • Name of the region for this request./// const region = 'us-central1'/*
  • Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
  • Name or id of the resource for this request. Name should conform to RFC1035.*/// const router = 'abc123'

    // Imports the Compute libraryconst {RoutersClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new RoutersClient();

    async function callListRoutePolicies() {// Construct requestconst request = {project,region,router,};

    // Run requestconst iterable = computeClient.listRoutePoliciesAsync(request);for await (const response of iterable) { console.log(response);}}

    callListRoutePolicies();

listRoutePoliciesStream(request, options)

listRoutePoliciesStream(request?:protos.google.cloud.compute.v1.IListRoutePoliciesRoutersRequest,options?:CallOptions):Transform;

Equivalent tolistRoutePolicies, but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListRoutePoliciesRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistRoutePoliciesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listStream(request, options)

listStream(request?:protos.google.cloud.compute.v1.IListRoutersRequest,options?:CallOptions):Transform;

Equivalent tolist, but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListRoutersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingRouter on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

patch(request, options)

patch(request?:protos.google.cloud.compute.v1.IPatchRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestIPatchRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Name of the Router resource to patch.   */// const router = 'abc123'/**   *  The body resource for this request   */// const routerResource = {}// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallPatch(){// Construct requestconstrequest={project,region,router,routerResource,};// Run requestconstresponse=awaitcomputeClient.patch(request);console.log(response);}callPatch();

patch(request, options, callback)

patch(request:protos.google.cloud.compute.v1.IPatchRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patch(request, callback)

patch(request:protos.google.cloud.compute.v1.IPatchRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patchRoutePolicy(request, options)

patchRoutePolicy(request?:protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Patches Route Policy

Parameters
NameDescription
requestIPatchRoutePolicyRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  The body resource for this request   */// const routePolicyResource = {}/**   *  Name of the Router resource where Route Policy is defined.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallPatchRoutePolicy(){// Construct requestconstrequest={project,region,routePolicyResource,router,};// Run requestconstresponse=awaitcomputeClient.patchRoutePolicy(request);console.log(response);}callPatchRoutePolicy();

patchRoutePolicy(request, options, callback)

patchRoutePolicy(request:protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchRoutePolicyRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patchRoutePolicy(request, callback)

patchRoutePolicy(request:protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchRoutePolicyRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

preview(request, options)

preview(request?:protos.google.cloud.compute.v1.IPreviewRouterRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest|undefined,{}|undefined]>;

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Parameters
NameDescription
requestIPreviewRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRoutersPreviewResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  Name of the Router resource to query.   */// const router = 'abc123'/**   *  The body resource for this request   */// const routerResource = {}// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallPreview(){// Construct requestconstrequest={project,region,router,routerResource,};// Run requestconstresponse=awaitcomputeClient.preview(request);console.log(response);}callPreview();

preview(request, options, callback)

preview(request:protos.google.cloud.compute.v1.IPreviewRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPreviewRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

preview(request, callback)

preview(request:protos.google.cloud.compute.v1.IPreviewRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPreviewRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IRoutersPreviewResponse,protos.google.cloud.compute.v1.IPreviewRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

update(request, options)

update(request?:protos.google.cloud.compute.v1.IUpdateRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Parameters
NameDescription
requestIUpdateRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Name of the Router resource to update.   */// const router = 'abc123'/**   *  The body resource for this request   */// const routerResource = {}// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallUpdate(){// Construct requestconstrequest={project,region,router,routerResource,};// Run requestconstresponse=awaitcomputeClient.update(request);console.log(response);}callUpdate();

update(request, options, callback)

update(request:protos.google.cloud.compute.v1.IUpdateRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

update(request, callback)

update(request:protos.google.cloud.compute.v1.IUpdateRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateRoutePolicy(request, options)

updateRoutePolicy(request?:protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Updates or creates new Route Policy

Parameters
NameDescription
requestIUpdateRoutePolicyRouterRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time..promise() is not supported yet.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'/**   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  The body resource for this request   */// const routePolicyResource = {}/**   *  Name of the Router resource where Route Policy is defined.   */// const router = 'abc123'// Imports the Compute libraryconst{RoutersClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRoutersClient();asyncfunctioncallUpdateRoutePolicy(){// Construct requestconstrequest={project,region,routePolicyResource,router,};// Run requestconstresponse=awaitcomputeClient.updateRoutePolicy(request);console.log(response);}callUpdateRoutePolicy();

updateRoutePolicy(request, options, callback)

updateRoutePolicy(request:protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateRoutePolicyRouterRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateRoutePolicy(request, callback)

updateRoutePolicy(request:protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateRoutePolicyRouterRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.