Class v1.NetworksClient (4.3.0)

The Networks API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of NetworksClient.

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 NetworksClient({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;
    };

networksStub

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

port

static get port(): number;

The port for this API service.

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

addPeering(request, options)

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

Adds a peering to the specified network.

Parameters
Name Description
request IAddPeeringNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network resource to add peering to.
   */
  // const network = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networksAddPeeringRequestResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

  async function callAddPeering() {
    // Construct request
    const request = {
      network,
      networksAddPeeringRequestResource,
      project,
    };

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

  callAddPeering();

addPeering(request, options, callback)

addPeering(request: protos.google.cloud.compute.v1.IAddPeeringNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddPeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAddPeeringNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddPeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

addPeering(request, callback)

addPeering(request: protos.google.cloud.compute.v1.IAddPeeringNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddPeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAddPeeringNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddPeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
Type Description
Promise<void>

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

delete(request, options)

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

Deletes the specified network.

Parameters
Name Description
request IDeleteNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network to delete.
   */
  // const network = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

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

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

  callDelete();

delete(request, options, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

delete(request, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

get(request, options)

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

Returns the specified network.

Parameters
Name Description
request IGetNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.compute.v1.INetwork, protos.google.cloud.compute.v1.IGetNetworkRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 network to return.
   */
  // const network = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'

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

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

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

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

  callGet();

get(request, options, callback)

get(request: protos.google.cloud.compute.v1.IGetNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.INetwork, protos.google.cloud.compute.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.INetwork, protos.google.cloud.compute.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.INetwork, protos.google.cloud.compute.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetNetworkRequest
callback Callback<protos.google.cloud.compute.v1.INetwork, protos.google.cloud.compute.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEffectiveFirewalls(request, options)

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

Returns the effective firewalls on a given network.

Parameters
Name Description
request IGetEffectiveFirewallsNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.compute.v1.INetworksGetEffectiveFirewallsResponse, (protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NetworksGetEffectiveFirewallsResponse. 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 network for this request.
   */
  // const network = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'

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

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

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

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

  callGetEffectiveFirewalls();

getEffectiveFirewalls(request, options, callback)

getEffectiveFirewalls(request: protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.INetworksGetEffectiveFirewallsResponse, protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEffectiveFirewallsNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.INetworksGetEffectiveFirewallsResponse, protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEffectiveFirewalls(request, callback)

getEffectiveFirewalls(request: protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.INetworksGetEffectiveFirewallsResponse, protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEffectiveFirewallsNetworkRequest
callback Callback<protos.google.cloud.compute.v1.INetworksGetEffectiveFirewallsResponse, protos.google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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

initialize()

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

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

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

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

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

insert(request, options)

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

Creates a network in the specified project using the data included in the request.

Parameters
Name Description
request IInsertNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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 networkResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

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

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

  callInsert();

insert(request, options, callback)

insert(request: protos.google.cloud.compute.v1.IInsertNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInsertNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

insert(request, callback)

insert(request: protos.google.cloud.compute.v1.IInsertNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInsertNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListNetworksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INetwork[],
        protos.google.cloud.compute.v1.IListNetworksRequest | null,
        protos.google.cloud.compute.v1.INetworkList
    ]>;

Retrieves the list of networks available to the specified project.

Parameters
Name Description
request IListNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.compute.v1.INetwork[], protos.google.cloud.compute.v1.IListNetworksRequest | null, protos.google.cloud.compute.v1.INetworkList ]>

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

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListNetworksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworksRequest, protos.google.cloud.compute.v1.INetworkList | null | undefined, protos.google.cloud.compute.v1.INetwork>): void;
Parameters
Name Description
request IListNetworksRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworksRequest, protos.google.cloud.compute.v1.INetworkList | null | undefined, protos.google.cloud.compute.v1.INetwork>
Returns
Type Description
void

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListNetworksRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworksRequest, protos.google.cloud.compute.v1.INetworkList | null | undefined, protos.google.cloud.compute.v1.INetwork>): void;
Parameters
Name Description
request IListNetworksRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworksRequest, protos.google.cloud.compute.v1.INetworkList | null | undefined, protos.google.cloud.compute.v1.INetwork>
Returns
Type Description
void

listAsync(request, options)

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

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 IListNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.compute.v1.INetwork>

{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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
 (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") 
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
 (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) 
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger 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

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

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

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

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

    callList();

listPeeringRoutes(request, options)

listPeeringRoutes(request?: protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IExchangedPeeringRoute[],
        protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest | null,
        protos.google.cloud.compute.v1.IExchangedPeeringRoutesList
    ]>;

Lists the peering routes exchanged over peering connection.

Parameters
Name Description
request IListPeeringRoutesNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.compute.v1.IExchangedPeeringRoute[], protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest | null, protos.google.cloud.compute.v1.IExchangedPeeringRoutesList ]>

{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 listPeeringRoutesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPeeringRoutes(request, options, callback)

listPeeringRoutes(request: protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, protos.google.cloud.compute.v1.IExchangedPeeringRoutesList | null | undefined, protos.google.cloud.compute.v1.IExchangedPeeringRoute>): void;
Parameters
Name Description
request IListPeeringRoutesNetworksRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, protos.google.cloud.compute.v1.IExchangedPeeringRoutesList | null | undefined, protos.google.cloud.compute.v1.IExchangedPeeringRoute>
Returns
Type Description
void

listPeeringRoutes(request, callback)

listPeeringRoutes(request: protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, protos.google.cloud.compute.v1.IExchangedPeeringRoutesList | null | undefined, protos.google.cloud.compute.v1.IExchangedPeeringRoute>): void;
Parameters
Name Description
request IListPeeringRoutesNetworksRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, protos.google.cloud.compute.v1.IExchangedPeeringRoutesList | null | undefined, protos.google.cloud.compute.v1.IExchangedPeeringRoute>
Returns
Type Description
void

listPeeringRoutesAsync(request, options)

listPeeringRoutesAsync(request?: protos.google.cloud.compute.v1.IListPeeringRoutesNetworksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IExchangedPeeringRoute>;

Equivalent to listPeeringRoutes, but returns an iterable object.

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

Parameters
Name Description
request IListPeeringRoutesNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.compute.v1.IExchangedPeeringRoute>

{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.
   */
  /**
   *  The direction of the exchanged routes.
   *  Check the Direction enum for the list of possible values.
   */
  // const direction = '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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
 (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") 
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
 (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) 
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger 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 network for this request. / // const network = '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' /*
  • The response will show routes exchanged over the given peering connection. / // const peeringName = 'abc123' /*
  • Project ID for this request. / // const project = 'my-project' /*
  • The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. / // 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 {NetworksClient} = require('@google-cloud/compute').v1;

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

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

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

    callListPeeringRoutes();

listPeeringRoutesStream(request, options)

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

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

Parameters
Name Description
request IListPeeringRoutesNetworksRequest

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 listPeeringRoutesAsync() 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.v1.IListNetworksRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

patch(request, options)

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

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Parameters
Name Description
request IPatchNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network to update.
   */
  // const network = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networkResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

  async function callPatch() {
    // Construct request
    const request = {
      network,
      networkResource,
      project,
    };

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

  callPatch();

patch(request, options, callback)

patch(request: protos.google.cloud.compute.v1.IPatchNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IPatchNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

patch(request, callback)

patch(request: protos.google.cloud.compute.v1.IPatchNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IPatchNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

removePeering(request, options)

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

Removes a peering from the specified network.

Parameters
Name Description
request IRemovePeeringNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network resource to remove peering from.
   */
  // const network = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networksRemovePeeringRequestResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

  async function callRemovePeering() {
    // Construct request
    const request = {
      network,
      networksRemovePeeringRequestResource,
      project,
    };

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

  callRemovePeering();

removePeering(request, options, callback)

removePeering(request: protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRemovePeeringNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

removePeering(request, callback)

removePeering(request: protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRemovePeeringNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemovePeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

switchToCustomMode(request, options)

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

Switches the network mode from auto subnet mode to custom subnet mode.

Parameters
Name Description
request ISwitchToCustomModeNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network to be updated.
   */
  // const network = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

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

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

  callSwitchToCustomMode();

switchToCustomMode(request, options, callback)

switchToCustomMode(request: protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISwitchToCustomModeNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

switchToCustomMode(request, callback)

switchToCustomMode(request: protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISwitchToCustomModeNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePeering(request, options)

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

Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.

Parameters
Name Description
request IUpdatePeeringNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation 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.
   */
  /**
   *  Name of the network resource which the updated peering is belonging to.
   */
  // const network = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networksUpdatePeeringRequestResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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'

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

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

  async function callUpdatePeering() {
    // Construct request
    const request = {
      network,
      networksUpdatePeeringRequestResource,
      project,
    };

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

  callUpdatePeering();

updatePeering(request, options, callback)

updatePeering(request: protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePeeringNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePeering(request, callback)

updatePeering(request: protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePeeringNetworkRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IUpdatePeeringNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void