Class v1.NetworkEndpointGroupsClient

The NetworkEndpointGroups API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of NetworkEndpointGroupsClient.

Parameter
NameDescription
opts ClientOptions

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;
    };

networkEndpointGroupsStub

networkEndpointGroupsStub?: 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.

warn

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

Methods

aggregatedListAsync(request, options)

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

Equivalent to aggregatedList, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IAggregatedListNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<[ string, protos.google.cloud.compute.v1.INetworkEndpointGroupsScopedList ]>

{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, [NetworkEndpointGroupsScopedList]]. 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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The 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) ```
   */
  // 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 {NetworkEndpointGroupsClient} = require('@google-cloud/compute').v1;

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

  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();

attachNetworkEndpoints(request, options)

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

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
   */
  // const networkEndpointGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networkEndpointGroupsAttachEndpointsRequestResource = {}
  /**
   *  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 name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

  async function callAttachNetworkEndpoints() {
    // Construct request
    const request = {
      networkEndpointGroup,
      networkEndpointGroupsAttachEndpointsRequestResource,
      project,
      zone,
    };

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

  callAttachNetworkEndpoints();

attachNetworkEndpoints(request, options, callback)

attachNetworkEndpoints(request: protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

attachNetworkEndpoints(request, callback)

attachNetworkEndpoints(request: protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAttachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
Promise<void>

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

delete(request, options)

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

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the network endpoint group to delete. It should comply with RFC1035.
   */
  // const networkEndpointGroup = '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'
  /**
   *  The name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

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

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

  callDelete();

delete(request, options, callback)

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

delete(request, callback)

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

detachNetworkEndpoints(request, options)

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

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
   */
  // const networkEndpointGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networkEndpointGroupsDetachEndpointsRequestResource = {}
  /**
   *  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 name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

  async function callDetachNetworkEndpoints() {
    // Construct request
    const request = {
      networkEndpointGroup,
      networkEndpointGroupsDetachEndpointsRequestResource,
      project,
      zone,
    };

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

  callDetachNetworkEndpoints();

detachNetworkEndpoints(request, options, callback)

detachNetworkEndpoints(request: protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

detachNetworkEndpoints(request, callback)

detachNetworkEndpoints(request: protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDetachNetworkEndpointsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INetworkEndpointGroup, (protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [NetworkEndpointGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the network endpoint group. It should comply with RFC1035.
   */
  // const networkEndpointGroup = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  The name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

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

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

  callGet();

get(request, options, callback)

get(request: protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.INetworkEndpointGroup, protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.INetworkEndpointGroup, protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest, callback: Callback<protos.google.cloud.compute.v1.INetworkEndpointGroup, protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest
callback Callback<protos.google.cloud.compute.v1.INetworkEndpointGroup, protos.google.cloud.compute.v1.IGetNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

insert(request, options)

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

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The body resource for this request
   */
  // const networkEndpointGroupResource = {}
  /**
   *  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 name of the zone where you want to create the network endpoint group. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

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

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

  callInsert();

insert(request, options, callback)

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

insert(request, callback)

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

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INetworkEndpointGroup[],
        protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest | null,
        protos.google.cloud.compute.v1.INetworkEndpointGroupList
    ]>;

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INetworkEndpointGroup[], protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest | null, protos.google.cloud.compute.v1.INetworkEndpointGroupList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [NetworkEndpointGroup]. 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.IListNetworkEndpointGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupList | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointGroup>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupList | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointGroup>
Returns
TypeDescription
void

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupList | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointGroup>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupList | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointGroup>
Returns
TypeDescription
void

listAsync(request, options)

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

Equivalent to list, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.INetworkEndpointGroup>

{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 [NetworkEndpointGroup]. 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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The 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) ```
   */
  // 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
  /**
   *  The name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

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

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

  callList();

listNetworkEndpoints(request, options)

listNetworkEndpoints(request?: protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus[],
        protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest | null,
        protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints
    ]>;

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus[], protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest | null, protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [NetworkEndpointWithHealthStatus]. 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 listNetworkEndpointsAsync() 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.

listNetworkEndpoints(request, options, callback)

listNetworkEndpoints(request: protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>
Returns
TypeDescription
void

listNetworkEndpoints(request, callback)

listNetworkEndpoints(request: protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, protos.google.cloud.compute.v1.INetworkEndpointGroupsListNetworkEndpoints | null | undefined, protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>
Returns
TypeDescription
void

listNetworkEndpointsAsync(request, options)

listNetworkEndpointsAsync(request?: protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>;

Equivalent to listNetworkEndpoints, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.INetworkEndpointWithHealthStatus>

{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 [NetworkEndpointWithHealthStatus]. 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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The 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) ```
   */
  // 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
  /**
   *  The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
   */
  // const networkEndpointGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const networkEndpointGroupsListEndpointsRequestResource = {}
  /**
   *  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
  /**
   *  The name of the zone where the network endpoint group is located. It should comply with RFC1035.
   */
  // const zone = 'abc123'

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

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

  async function callListNetworkEndpoints() {
    // Construct request
    const request = {
      networkEndpointGroup,
      networkEndpointGroupsListEndpointsRequestResource,
      project,
      zone,
    };

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

  callListNetworkEndpoints();

listNetworkEndpointsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointsNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [NetworkEndpointWithHealthStatus] 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 listNetworkEndpointsAsync() 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.

listStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNetworkEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [NetworkEndpointGroup] 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.

testIamPermissions(request, options)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
request protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.ITestPermissionsResponse, (protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestPermissionsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'
  /**
   *  The body resource for this request
   */
  // const testPermissionsRequestResource = {}
  /**
   *  The name of the zone for this request.
   */
  // const zone = 'abc123'

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

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

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

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

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsNetworkEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

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