Class v1.TargetHttpsProxiesClient (3.6.0)

The TargetHttpsProxies API. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of TargetHttpsProxiesClient.

Parameters

Name	Description
opts	`ClientOptions`
gaxInstance	`typeof gax \| typeof gax.fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new TargetHttpsProxiesClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

port

static get port(): number;

The port for this API service.

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.

targetHttpsProxiesStub

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

warn

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

Methods

aggregatedListAsync(request, options)

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

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

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

Parameters

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

Returns

Type

Description

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing as tuple [string, [TargetHttpsProxiesScopedList]]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
   */
  // const filter = 'abc123'
  /**
   *  Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
   */
  // const includeAllScopes = true
  /**
   *  The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
   */
  // const maxResults = 1234
  /**
   *  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
   */
  // const pageToken = 'abc123'
  /**
   *  Name of the project scoping 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 {TargetHttpsProxiesClient} = require('@google-cloud/compute').v1;

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

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

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

  callAggregatedList();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

delete(request, options)

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

Deletes the specified TargetHttpsProxy resource.

Parameters

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

Returns

Type Description

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 TargetHttpsProxy resource to delete.
   */
  // const targetHttpsProxy = 'abc123'

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

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

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

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

  callDelete();

delete(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IDeleteTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

delete(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IDeleteTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

get(request, options)

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

Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest` 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.ITargetHttpsProxy, protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TargetHttpsProxy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  Name of the TargetHttpsProxy resource to return.
   */
  // const targetHttpsProxy = 'abc123'

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

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

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

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

  callGet();

get(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.ITargetHttpsProxy, protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

get(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.ITargetHttpsProxy, protos.google.cloud.compute.v1.IGetTargetHttpsProxyRequest \| 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.IInsertTargetHttpsProxyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 targetHttpsProxyResource = {}

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

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

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

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

  callInsert();

insert(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IInsertTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

insert(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IInsertTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.ITargetHttpsProxy[],
        protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest | null,
        protos.google.cloud.compute.v1.ITargetHttpsProxyList
    ]>;

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest` 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.ITargetHttpsProxy[], protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest | null, protos.google.cloud.compute.v1.ITargetHttpsProxyList ]>

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

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, protos.google.cloud.compute.v1.ITargetHttpsProxyList | null | undefined, protos.google.cloud.compute.v1.ITargetHttpsProxy>): void;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, protos.google.cloud.compute.v1.ITargetHttpsProxyList \| null \| undefined, protos.google.cloud.compute.v1.ITargetHttpsProxy>`

Returns

Type	Description
void

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, protos.google.cloud.compute.v1.ITargetHttpsProxyList | null | undefined, protos.google.cloud.compute.v1.ITargetHttpsProxy>): void;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest`
callback	`PaginationCallback<protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest, protos.google.cloud.compute.v1.ITargetHttpsProxyList \| null \| undefined, protos.google.cloud.compute.v1.ITargetHttpsProxy>`

Returns

Type	Description
void

listAsync(request, options)

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

Equivalent to list, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest` 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.ITargetHttpsProxy>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [TargetHttpsProxy]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
   */
  // const maxResults = 1234
  /**
   *  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
   */
  // const pageToken = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 {TargetHttpsProxiesClient} = require('@google-cloud/compute').v1;

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

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

    // 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.IListTargetHttpsProxiesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListTargetHttpsProxiesRequest` 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 [TargetHttpsProxy] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

patch(request, options)

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

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

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 TargetHttpsProxy resource to patch.
   */
  // const targetHttpsProxy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const targetHttpsProxyResource = {}

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

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

  async function callPatch() {
    // Construct request
    const request = {
      project,
      targetHttpsProxy,
      targetHttpsProxyResource,
    };

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

  callPatch();

patch(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IPatchTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

patch(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IPatchTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setCertificateMap(request, options)

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

Changes the Certificate Map for TargetHttpsProxy.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 targetHttpsProxiesSetCertificateMapRequestResource = {}
  /**
   *  Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
   */
  // const targetHttpsProxy = 'abc123'

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

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

  async function callSetCertificateMap() {
    // Construct request
    const request = {
      project,
      targetHttpsProxiesSetCertificateMapRequestResource,
      targetHttpsProxy,
    };

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

  callSetCertificateMap();

setCertificateMap(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetCertificateMapTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetCertificateMapTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setCertificateMap(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetCertificateMapTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetCertificateMapTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setQuicOverride(request, options)

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

Sets the QUIC override policy for TargetHttpsProxy.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 targetHttpsProxiesSetQuicOverrideRequestResource = {}
  /**
   *  Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.
   */
  // const targetHttpsProxy = 'abc123'

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

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

  async function callSetQuicOverride() {
    // Construct request
    const request = {
      project,
      targetHttpsProxiesSetQuicOverrideRequestResource,
      targetHttpsProxy,
    };

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

  callSetQuicOverride();

setQuicOverride(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetQuicOverrideTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetQuicOverrideTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setQuicOverride(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetQuicOverrideTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetQuicOverrideTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setSslCertificates(request, options)

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

Replaces SslCertificates for TargetHttpsProxy.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 targetHttpsProxiesSetSslCertificatesRequestResource = {}
  /**
   *  Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
   */
  // const targetHttpsProxy = 'abc123'

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

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

  async function callSetSslCertificates() {
    // Construct request
    const request = {
      project,
      targetHttpsProxiesSetSslCertificatesRequestResource,
      targetHttpsProxy,
    };

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

  callSetSslCertificates();

setSslCertificates(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetSslCertificatesTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSslCertificatesTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setSslCertificates(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetSslCertificatesTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSslCertificatesTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setSslPolicy(request, options)

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

Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 sslPolicyReferenceResource = {}
  /**
   *  Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
   */
  // const targetHttpsProxy = 'abc123'

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

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

  async function callSetSslPolicy() {
    // Construct request
    const request = {
      project,
      sslPolicyReferenceResource,
      targetHttpsProxy,
    };

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

  callSetSslPolicy();

setSslPolicy(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetSslPolicyTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSslPolicyTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setSslPolicy(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetSslPolicyTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSslPolicyTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setUrlMap(request, options)

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

Changes the URL map for TargetHttpsProxy.

Parameters

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

Returns

Type Description

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  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 TargetHttpsProxy resource whose URL map is to be set.
   */
  // const targetHttpsProxy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const urlMapReferenceResource = {}

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

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

  async function callSetUrlMap() {
    // Construct request
    const request = {
      project,
      targetHttpsProxy,
      urlMapReferenceResource,
    };

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

  callSetUrlMap();

setUrlMap(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetUrlMapTargetHttpsProxyRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetUrlMapTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setUrlMap(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetUrlMapTargetHttpsProxyRequest`
callback	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetUrlMapTargetHttpsProxyRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void