Class v1beta.RoutersClient (6.9.0)

6.9.0 (latest) 6.7.0 6.5.0 4.11.0 4.10.0 4.9.0 4.8.0 4.6.0 4.5.0 4.3.0 4.1.0 3.9.1 3.8.1 3.6.0 3.5.1 3.1.2 3.0.0

The Routers API. v1beta

Package

@google-cloud/compute

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 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: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

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.

universeDomain

get universeDomain(): string;

warn

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

Methods

aggregatedListAsync(request, options)

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

Retrieves an aggregated list of routers.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Parameters
Name	Description
request	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.v1beta.IRoutersScopedList]>	{Object} An iterable Object that allows async 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 the documentation 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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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.
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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callAggregatedList() {
// Construct request
const request = {
project,
};
// Run request
const 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
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

delete(request, options)

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

Deletes the specified Router resource.

Parameters
Name	Description
request	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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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').v1beta;

  // 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.v1beta.IDeleteRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

delete(request, callback)

delete(request: protos.google.cloud.compute.v1beta.IDeleteRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteNamedSet(request, options)

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

Deletes Named Set

Parameters
Name	Description
request	IDeleteNamedSetRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 Named Set name for this request. Name must conform to RFC1035
   */
  // const namedSet = '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 Named Set is defined.
   */
  // const router = 'abc123'

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

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

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

    // Run request
    const response = await computeClient.deleteNamedSet(request);
    console.log(response);
  }

  callDeleteNamedSet();

deleteNamedSet(request, options, callback)

deleteNamedSet(request: protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteNamedSetRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteNamedSet(request, callback)

deleteNamedSet(request: protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteNamedSetRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteRoutePolicy(request, options)

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

Deletes Route Policy

Parameters
Name	Description
request	IDeleteRoutePolicyRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

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

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

    // Run request
    const response = await computeClient.deleteRoutePolicy(request);
    console.log(response);
  }

  callDeleteRoutePolicy();

deleteRoutePolicy(request, options, callback)

deleteRoutePolicy(request: protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteRoutePolicyRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteRoutePolicy(request, callback)

deleteRoutePolicy(request: protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteRoutePolicyRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

get(request, options)

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

Returns the specified Router resource.

Parameters
Name	Description
request	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.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Router. Please see the documentation 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').v1beta;

  // 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.v1beta.IGetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

get(request, callback)

get(request: protos.google.cloud.compute.v1beta.IGetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNamedSet(request, options)

getNamedSet(request?: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse,
        protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | undefined,
        {} | undefined
    ]>;

Returns specified Named Set

Parameters
Name	Description
request	IGetNamedSetRouterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing RoutersGetNamedSetResponse. Please see the documentation 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 Named Set name for this request. Name must conform to RFC1035
   */
  // const namedSet = '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 named set. The name should
   *  conform to RFC1035.
   */
  // const router = 'abc123'

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

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

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

    // Run request
    const response = await computeClient.getNamedSet(request);
    console.log(response);
  }

  callGetNamedSet();

getNamedSet(request, options, callback)

getNamedSet(request: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNamedSetRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNamedSet(request, callback)

getNamedSet(request: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNamedSetRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNatIpInfo(request, options)

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

Retrieves runtime NAT IP information.

Parameters
Name	Description
request	IGetNatIpInfoRouterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing NatIpInfoResponse. Please see the documentation 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

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

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

    // Run request
    const response = await computeClient.getNatIpInfo(request);
    console.log(response);
  }

  callGetNatIpInfo();

getNatIpInfo(request, options, callback)

getNatIpInfo(request: protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNatIpInfoRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNatIpInfo(request, callback)

getNatIpInfo(request: protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNatIpInfoRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNatMappingInfo(request, options)

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

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
request	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.v1beta.IVmEndpointNatMappings[], protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest | null, protos.google.cloud.compute.v1beta.IVmEndpointNatMappingsList ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of VmEndpointNatMappings. 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 for more details and examples.

getNatMappingInfo(request, options, callback)

getNatMappingInfo(request: protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, protos.google.cloud.compute.v1beta.IVmEndpointNatMappingsList | null | undefined, protos.google.cloud.compute.v1beta.IVmEndpointNatMappings>): void;

Parameters
Name	Description
request	IGetNatMappingInfoRoutersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, protos.google.cloud.compute.v1beta.IVmEndpointNatMappingsList | null | undefined, protos.google.cloud.compute.v1beta.IVmEndpointNatMappings>

Returns
Type	Description
void

getNatMappingInfo(request, callback)

getNatMappingInfo(request: protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, protos.google.cloud.compute.v1beta.IVmEndpointNatMappingsList | null | undefined, protos.google.cloud.compute.v1beta.IVmEndpointNatMappings>): void;

Parameters
Name	Description
request	IGetNatMappingInfoRoutersRequest
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, protos.google.cloud.compute.v1beta.IVmEndpointNatMappingsList | null | undefined, protos.google.cloud.compute.v1beta.IVmEndpointNatMappings>

Returns
Type	Description
void

getNatMappingInfoAsync(request, options)

getNatMappingInfoAsync(request?: protos.google.cloud.compute.v1beta.IGetNatMappingInfoRoutersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1beta.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	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.v1beta.IVmEndpointNatMappings>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing VmEndpointNatMappings. 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 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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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
/*
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 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.
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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callGetNatMappingInfo() {
// Construct request
const request = {
project,
region,
router,
};
// Run request
const iterable = computeClient.getNatMappingInfoAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callGetNatMappingInfo();

getNatMappingInfoStream(request, options)

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

Equivalent to getNatMappingInfo, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 VmEndpointNatMappings 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 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

getRoutePolicy(request, options)

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

Returns specified Route Policy

Parameters
Name	Description
request	IGetRoutePolicyRouterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing RoutersGetRoutePolicyResponse. Please see the documentation 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

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

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

    // Run request
    const response = await computeClient.getRoutePolicy(request);
    console.log(response);
  }

  callGetRoutePolicy();

getRoutePolicy(request, options, callback)

getRoutePolicy(request: protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRoutePolicyRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRoutePolicy(request, callback)

getRoutePolicy(request: protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRoutePolicyRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRouterStatus(request, options)

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

Retrieves runtime information of the specified router.

Parameters
Name	Description
request	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.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing RouterStatusResponse. Please see the documentation 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').v1beta;

  // 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.v1beta.IGetRouterStatusRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRouterStatusRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRouterStatus(request, callback)

getRouterStatus(request: protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRouterStatusRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.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.v1beta.IInsertRouterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
        protos.google.cloud.compute.v1beta.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
Name	Description
request	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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

  // 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.v1beta.IInsertRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IInsertRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

insert(request, callback)

insert(request: protos.google.cloud.compute.v1beta.IInsertRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IInsertRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

list(request, options)

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

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

Parameters
Name	Description
request	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.v1beta.IRouter[], protos.google.cloud.compute.v1beta.IListRoutersRequest | null, protos.google.cloud.compute.v1beta.IRouterList ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Router. 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 for more details and examples.

list(request, options, callback)

list(request: protos.google.cloud.compute.v1beta.IListRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutersRequest, protos.google.cloud.compute.v1beta.IRouterList | null | undefined, protos.google.cloud.compute.v1beta.IRouter>): void;

Parameters
Name	Description
request	IListRoutersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutersRequest, protos.google.cloud.compute.v1beta.IRouterList | null | undefined, protos.google.cloud.compute.v1beta.IRouter>

Returns
Type	Description
void

list(request, callback)

list(request: protos.google.cloud.compute.v1beta.IListRoutersRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutersRequest, protos.google.cloud.compute.v1beta.IRouterList | null | undefined, protos.google.cloud.compute.v1beta.IRouter>): void;

Parameters
Name	Description
request	IListRoutersRequest
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutersRequest, protos.google.cloud.compute.v1beta.IRouterList | null | undefined, protos.google.cloud.compute.v1beta.IRouter>

Returns
Type	Description
void

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1beta.IListRoutersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1beta.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	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.v1beta.IRouter>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Router. 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 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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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.
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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callList() {
// Construct request
const request = {
project,
region,
};
// Run request
const iterable = computeClient.listAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callList();

listBgpRoutes(request, options)

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

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

Parameters
Name	Description
request	IListBgpRoutesRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.IBgpRoute[], protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest | null, protos.google.cloud.compute.v1beta.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 using listBgpRoutesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBgpRoutes(request, options, callback)

listBgpRoutes(request: protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListBgpRoutes | null | undefined, protos.google.cloud.compute.v1beta.IBgpRoute>): void;

Parameters
Name	Description
request	IListBgpRoutesRoutersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListBgpRoutes | null | undefined, protos.google.cloud.compute.v1beta.IBgpRoute>

Returns
Type	Description
void

listBgpRoutes(request, callback)

listBgpRoutes(request: protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListBgpRoutes | null | undefined, protos.google.cloud.compute.v1beta.IBgpRoute>): void;

Parameters
Name	Description
request	IListBgpRoutesRoutersRequest
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListBgpRoutesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListBgpRoutes | null | undefined, protos.google.cloud.compute.v1beta.IBgpRoute>

Returns
Type	Description
void

listBgpRoutesAsync(request, options)

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

Equivalent to listBgpRoutes, but returns an iterable object.

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

Parameters
Name	Description
request	IListBgpRoutesRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.compute.v1beta.IBgpRoute>	{Object} An iterable Object that allows async 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 the documentation 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'
  /**
   *  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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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'
/*
(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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callListBgpRoutes() {
// Construct request
const request = {
project,
region,
router,
};
// Run request
const iterable = computeClient.listBgpRoutesAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callListBgpRoutes();

listBgpRoutesStream(request, options)

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

Equivalent to listBgpRoutes, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListBgpRoutesRoutersRequest 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 listBgpRoutesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNamedSets(request, options)

listNamedSets(request?: protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1beta.INamedSet[],
        protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest | null,
        protos.google.cloud.compute.v1beta.IRoutersListNamedSets
    ]>;

Retrieves a list of router named set subresources available to the specified project.

Parameters
Name	Description
request	IListNamedSetsRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.INamedSet[], protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest | null, protos.google.cloud.compute.v1beta.IRoutersListNamedSets ]>	{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 listNamedSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNamedSets(request, options, callback)

listNamedSets(request: protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListNamedSets | null | undefined, protos.google.cloud.compute.v1beta.INamedSet>): void;

Parameters
Name	Description
request	IListNamedSetsRoutersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListNamedSets | null | undefined, protos.google.cloud.compute.v1beta.INamedSet>

Returns
Type	Description
void

listNamedSets(request, callback)

listNamedSets(request: protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListNamedSets | null | undefined, protos.google.cloud.compute.v1beta.INamedSet>): void;

Parameters
Name	Description
request	IListNamedSetsRoutersRequest
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListNamedSets | null | undefined, protos.google.cloud.compute.v1beta.INamedSet>

Returns
Type	Description
void

listNamedSetsAsync(request, options)

listNamedSetsAsync(request?: protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1beta.INamedSet>;

Equivalent to listNamedSets, but returns an iterable object.

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

Parameters
Name	Description
request	IListNamedSetsRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.compute.v1beta.INamedSet>	{Object} An iterable Object that allows async 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 the documentation 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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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.
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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callListNamedSets() {
// Construct request
const request = {
project,
region,
router,
};
// Run request
const iterable = computeClient.listNamedSetsAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callListNamedSets();

listNamedSetsStream(request, options)

listNamedSetsStream(request?: protos.google.cloud.compute.v1beta.IListNamedSetsRoutersRequest, options?: CallOptions): Transform;

Equivalent to listNamedSets, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListNamedSetsRoutersRequest 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 listNamedSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRoutePolicies(request, options)

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

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

Parameters
Name	Description
request	IListRoutePoliciesRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.IRoutePolicy[], protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest | null, protos.google.cloud.compute.v1beta.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 using listRoutePoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRoutePolicies(request, options, callback)

listRoutePolicies(request: protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListRoutePolicies | null | undefined, protos.google.cloud.compute.v1beta.IRoutePolicy>): void;

Parameters
Name	Description
request	IListRoutePoliciesRoutersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListRoutePolicies | null | undefined, protos.google.cloud.compute.v1beta.IRoutePolicy>

Returns
Type	Description
void

listRoutePolicies(request, callback)

listRoutePolicies(request: protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListRoutePolicies | null | undefined, protos.google.cloud.compute.v1beta.IRoutePolicy>): void;

Parameters
Name	Description
request	IListRoutePoliciesRoutersRequest
callback	PaginationCallback<protos.google.cloud.compute.v1beta.IListRoutePoliciesRoutersRequest, protos.google.cloud.compute.v1beta.IRoutersListRoutePolicies | null | undefined, protos.google.cloud.compute.v1beta.IRoutePolicy>

Returns
Type	Description
void

listRoutePoliciesAsync(request, options)

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

Equivalent to listRoutePolicies, but returns an iterable object.

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

Parameters
Name	Description
request	IListRoutePoliciesRoutersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.compute.v1beta.IRoutePolicy>	{Object} An iterable Object that allows async 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 the documentation 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.
   *  These two types of filter expressions cannot be mixed in one request.
   *  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 `:*` 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 onresource 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 GoogleRE2 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 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.
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 library
const {RoutersClient} = require('@google-cloud/compute').v1beta;
// Instantiates a client
const computeClient = new RoutersClient();
async function callListRoutePolicies() {
// Construct request
const request = {
project,
region,
router,
};
// Run request
const iterable = computeClient.listRoutePoliciesAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callListRoutePolicies();

listRoutePoliciesStream(request, options)

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

Equivalent to listRoutePolicies, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListRoutePoliciesRoutersRequest 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 listRoutePoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listStream(request, options)

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

Equivalent to list, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 Router 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 for more details and examples.

patch(request, options)

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

Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name	Description
request	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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

  // 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.v1beta.IPatchRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

patch(request, callback)

patch(request: protos.google.cloud.compute.v1beta.IPatchRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

patchNamedSet(request, options)

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

Patches Named Set

Parameters
Name	Description
request	IPatchNamedSetRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 body resource for this request
   */
  // const namedSetResource = {}
  /**
   *  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 Named Set is defined.
   */
  // const router = 'abc123'

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

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

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

    // Run request
    const response = await computeClient.patchNamedSet(request);
    console.log(response);
  }

  callPatchNamedSet();

patchNamedSet(request, options, callback)

patchNamedSet(request: protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchNamedSetRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

patchNamedSet(request, callback)

patchNamedSet(request: protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchNamedSetRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

patchRoutePolicy(request, options)

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

Patches Route Policy

Parameters
Name	Description
request	IPatchRoutePolicyRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

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

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

    // Run request
    const response = await computeClient.patchRoutePolicy(request);
    console.log(response);
  }

  callPatchRoutePolicy();

patchRoutePolicy(request, options, callback)

patchRoutePolicy(request: protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchRoutePolicyRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

patchRoutePolicy(request, callback)

patchRoutePolicy(request: protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPatchRoutePolicyRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

preview(request, options)

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

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

Parameters
Name	Description
request	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.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing RoutersPreviewResponse. Please see the documentation 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').v1beta;

  // 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.v1beta.IPreviewRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPreviewRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

preview(request, callback)

preview(request: protos.google.cloud.compute.v1beta.IPreviewRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IPreviewRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1beta.ITestPermissionsResponse,
        protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | undefined,
        {} | undefined
    ]>;

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	ITestIamPermissionsRouterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestPermissionsResponse. Please see the documentation 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'
  /**
   *  The name of the region for this request.
   */
  // const region = 'us-central1'
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'
  /**
   *  The body resource for this request
   */
  // const testPermissionsRequestResource = {}

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

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

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      project,
      region,
      resource,
      testPermissionsRequestResource,
    };

    // Run request
    const response = await computeClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

update(request, options)

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

Updates the specified Router resource with the data included in the request. This method conforms toPUT 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	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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

  // 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.v1beta.IUpdateRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

update(request, callback)

update(request: protos.google.cloud.compute.v1beta.IUpdateRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateNamedSet(request, options)

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

Updates or creates new Named Set

Parameters
Name	Description
request	IUpdateNamedSetRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 body resource for this request
   */
  // const namedSetResource = {}
  /**
   *  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 Named Set is defined.
   */
  // const router = 'abc123'

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

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

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

    // Run request
    const response = await computeClient.updateNamedSet(request);
    console.log(response);
  }

  callUpdateNamedSet();

updateNamedSet(request, options, callback)

updateNamedSet(request: protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateNamedSetRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateNamedSet(request, callback)

updateNamedSet(request: protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateNamedSetRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateRoutePolicy(request, options)

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

Updates or creates new Route Policy

Parameters
Name	Description
request	IUpdateRoutePolicyRouterRequest 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.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.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 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 library
  const {RoutersClient} = require('@google-cloud/compute').v1beta;

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

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

    // Run request
    const response = await computeClient.updateRoutePolicy(request);
    console.log(response);
  }

  callUpdateRoutePolicy();

updateRoutePolicy(request, options, callback)

updateRoutePolicy(request: protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRoutePolicyRouterRequest
options	CallOptions
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateRoutePolicy(request, callback)

updateRoutePolicy(request: protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRoutePolicyRouterRequest
callback	Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRoutePolicyRouterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void