Class v1.VpnGatewaysClient (3.9.1)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

vpnGatewaysStub

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

warn

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

Methods

aggregatedListAsync(request, options)

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: 
 labels.owner:* 
 You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: 
 (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") 
 By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: 
 (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) 
 If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
   /
  // const filter = 'abc123'
  /*

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
/
// const includeAllScopes = true
/*
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
/
// const maxResults = 1234
/*
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
/
// const orderBy = 'abc123'
/*
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
/
// const pageToken = 'abc123'
/*
Project ID for this request.
/
// const project = 'my-project'
/*
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {VpnGatewaysClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new VpnGatewaysClient();
async function callAggregatedList() {
// Construct request
const request = {
project,
};
// Run request
const iterable = await computeClient.aggregatedListAsync(request);
for await (const [key, value] of iterable) {
  console.log(response);
}
}
callAggregatedList();

close()

close(): Promise<void>;

delete(request, options)

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

  /**
   * 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 VPN gateway to delete.
   */
  // const vpnGateway = 'abc123'

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

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

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

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

  callDelete();

delete(request, options, callback)

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

delete(request, callback)

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

get(request, options)

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

  /**
   * 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 VPN gateway to return.
   */
  // const vpnGateway = 'abc123'

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

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

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

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

  callGet();

get(request, options, callback)

get(request: protos.google.cloud.compute.v1.IGetVpnGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IVpnGateway, protos.google.cloud.compute.v1.IGetVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetVpnGatewayRequest, callback: Callback<protos.google.cloud.compute.v1.IVpnGateway, protos.google.cloud.compute.v1.IGetVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

getStatus(request, options)

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

  /**
   * 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 VPN gateway to return.
   */
  // const vpnGateway = 'abc123'

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

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

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

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

  callGetStatus();

getStatus(request, options, callback)

getStatus(request: protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IVpnGatewaysGetStatusResponse, protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

getStatus(request, callback)

getStatus(request: protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest, callback: Callback<protos.google.cloud.compute.v1.IVpnGatewaysGetStatusResponse, protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

initialize()

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

insert(request, options)

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

  /**
   * 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 vpnGatewayResource = {}

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

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

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

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

  callInsert();

insert(request, options, callback)

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

insert(request, callback)

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

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListVpnGatewaysRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IVpnGateway[],
        protos.google.cloud.compute.v1.IListVpnGatewaysRequest | null,
        protos.google.cloud.compute.v1.IVpnGatewayList
    ]>;

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListVpnGatewaysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListVpnGatewaysRequest, protos.google.cloud.compute.v1.IVpnGatewayList | null | undefined, protos.google.cloud.compute.v1.IVpnGateway>): void;

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListVpnGatewaysRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListVpnGatewaysRequest, protos.google.cloud.compute.v1.IVpnGatewayList | null | undefined, protos.google.cloud.compute.v1.IVpnGateway>): void;

listAsync(request, options)

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: 
 labels.owner:* 
 You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: 
 (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") 
 By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: 
 (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) 
 If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
   /
  // const filter = 'abc123'
  /*

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
/
// const maxResults = 1234
/*
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
/
// const orderBy = 'abc123'
/*
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
/
// const pageToken = 'abc123'
/*
Project ID for this request.
/
// const project = 'my-project'
/*
Name of the region for this request.
/
// const region = 'us-central1'
/*
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {VpnGatewaysClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new VpnGatewaysClient();
async function callList() {
// Construct request
const request = {
project,
region,
};
// Run request
const iterable = await computeClient.listAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callList();

listStream(request, options)

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

setLabels(request, options)

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

  /**
   * 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 region for this request.
   */
  // const region = 'us-central1'
  /**
   *  The body resource for this request
   */
  // const regionSetLabelsRequestResource = {}
  /**
   *  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 or id of the resource for this request.
   */
  // const resource = 'abc123'

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

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

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

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

  callSetLabels();

setLabels(request, options, callback)

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

setLabels(request, callback)

setLabels(request: protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

testIamPermissions(request, options)

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

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

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

  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.v1.ITestIamPermissionsVpnGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest | null | undefined, {} | null | undefined>): void;

testIamPermissions(request, callback)

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