Class v1.RoutersClient (3.8.1)

The Routers API. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of RoutersClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof gax.fallback` : loaded instance of `google-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: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

port

static get port(): number;

The port for this API service.

routersStub

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

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

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.

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

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IAggregatedListRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing as tuple [string, ]. 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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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`.
   */
  // 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 than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, 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 using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` 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 by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` 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.
   */
  // const returnPartialSuccess = true

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

  // Instantiates a client
  const computeClient = new RoutersClient();

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

    // Run request
    const iterable = await 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
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IDeleteRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callDelete() {
    // Construct request
    const request = {
      project,
      region,
      router,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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. Gets a list of available routers by making a list() request.

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IGetRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`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 representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callGet() {
    // Construct request
    const request = {
      project,
      region,
      router,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 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 using getNatMappingInfoAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`void`

getNatMappingInfoAsync(request, options)

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

Equivalent to getNatMappingInfo, but returns an iterable object.

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

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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`.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, 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 using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` 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 by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` 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.
   */
  // const returnPartialSuccess = true
  /**
   *  Name of the Router resource to query for Nat Mapping information of VM endpoints.
   */
  // const router = 'abc123'

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

  // Instantiates a client
  const computeClient = new RoutersClient();

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

    // Run request
    const iterable = await 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 to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 using getNatMappingInfoAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IGetRouterStatusRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`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 representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callGetRouterStatus() {
    // Construct request
    const request = {
      project,
      region,
      router,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IInsertRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callInsert() {
    // Construct request
    const request = {
      project,
      region,
      routerResource,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IListRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 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 using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`void`

listAsync(request, options)

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

Equivalent to list, but returns an iterable object.

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

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IListRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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`.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, 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 using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` 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 by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` 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.
   */
  // const returnPartialSuccess = true

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

  // Instantiates a client
  const computeClient = new RoutersClient();

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

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

  callList();

listStream(request, options)

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

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.compute.v1.IListRoutersRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
Name	Description
`request`	`protos.google.cloud.compute.v1.IPatchRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callPatch() {
    // Construct request
    const request = {
      project,
      region,
      router,
      routerResource,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IPreviewRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`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 representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callPreview() {
    // Construct request
    const request = {
      project,
      region,
      router,
      routerResource,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`request`	`protos.google.cloud.compute.v1.IUpdateRouterRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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

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 library
  const {RoutersClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RoutersClient();

  async function callUpdate() {
    // Construct request
    const request = {
      project,
      region,
      router,
      routerResource,
    };

    // Run request
    const response = await computeClient.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
Name	Description
`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>`

Returns
Type	Description
`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
Name	Description
`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>`

Returns
Type	Description
`void`