Class v1.NodeGroupsClient

The NodeGroups API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of NodeGroupsClient.

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

nodeGroupsStub

nodeGroupsStub?: 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

addNodes(request, options)

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

Adds specified number of nodes to the node group.

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

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.
   */
  /**
   *  Name of the NodeGroup resource.
   */
  // const nodeGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const nodeGroupsAddNodesRequestResource = {}
  /**
   *  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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callAddNodes() {
    // Construct request
    const request = {
      nodeGroup,
      nodeGroupsAddNodesRequestResource,
      project,
      zone,
    };

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

  callAddNodes();

addNodes(request, options, callback)

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

addNodes(request, callback)

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

aggregatedListAsync(request, options)

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

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.IAggregatedListNodeGroupsRequest

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.INodeGroupsScopedList ]>

{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, [NodeGroupsScopedList]]. 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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`." 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="" {nodegroupsclient}="require('@google-cloud/compute').v1;" instantiates="" a="" client="" const="" computeclient="new" nodegroupsclient();="" 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
TypeDescription
Promise<void>

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

delete(request, options)

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

Deletes the specified NodeGroup resource.

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

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.
   */
  /**
   *  Name of the NodeGroup resource to delete.
   */
  // const nodeGroup = '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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callDelete() {
    // Construct request
    const request = {
      nodeGroup,
      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.IDeleteNodeGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNodeGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteNodeGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteNodeGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

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

deleteNodes(request, options)

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

Deletes specified nodes from the node group.

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

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.
   */
  /**
   *  Name of the NodeGroup resource whose nodes will be deleted.
   */
  // const nodeGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const nodeGroupsDeleteNodesRequestResource = {}
  /**
   *  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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callDeleteNodes() {
    // Construct request
    const request = {
      nodeGroup,
      nodeGroupsDeleteNodesRequestResource,
      project,
      zone,
    };

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

  callDeleteNodes();

deleteNodes(request, options, callback)

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

deleteNodes(request, callback)

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

get(request, options)

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

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INodeGroup, protos.google.cloud.compute.v1.IGetNodeGroupRequest | undefined, {} | undefined ]>

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

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

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

  async function callGet() {
    // Construct request
    const request = {
      nodeGroup,
      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.IGetNodeGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.INodeGroup, protos.google.cloud.compute.v1.IGetNodeGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetNodeGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.INodeGroup, protos.google.cloud.compute.v1.IGetNodeGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

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

getIamPolicy(request, options)

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

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. 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.
   */
  /**
   *  Requested IAM Policy version.
   */
  // const optionsRequestedPolicyVersion = 1234
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'
  /**
   *  The name of the zone for this request.
   */
  // const zone = 'abc123'

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

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

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

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

  callGetIamPolicy();

getIamPolicy(request, options, callback)

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

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest
callback Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest | 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.IInsertNodeGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

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

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

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.
   */
  /**
   *  Initial count of nodes in the node group.
   */
  // const initialNodeCount = 1234
  /**
   *  The body resource for this request
   */
  // const nodeGroupResource = {}
  /**
   *  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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callInsert() {
    // Construct request
    const request = {
      initialNodeCount,
      nodeGroupResource,
      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.IInsertNodeGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNodeGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertNodeGroupRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertNodeGroupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

insert(request, callback)

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

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListNodeGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INodeGroup[],
        protos.google.cloud.compute.v1.IListNodeGroupsRequest | null,
        protos.google.cloud.compute.v1.INodeGroupList
    ]>;

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INodeGroup[], protos.google.cloud.compute.v1.IListNodeGroupsRequest | null, protos.google.cloud.compute.v1.INodeGroupList ]>

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

list(request, callback)

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

listAsync(request, options)

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

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.IListNodeGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [NodeGroup]. 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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`." 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="" for="" this="" request.="" */="" const="" zone='abc123' imports="" the="" compute="" library="" const="" {nodegroupsclient}="require('@google-cloud/compute').v1;" instantiates="" a="" client="" const="" computeclient="new" nodegroupsclient();="" 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();="">

listNodes(request, options)

listNodes(request?: protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INodeGroupNode[],
        protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest | null,
        protos.google.cloud.compute.v1.INodeGroupsListNodes
    ]>;

Lists nodes in the node group.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.INodeGroupNode[], protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest | null, protos.google.cloud.compute.v1.INodeGroupsListNodes ]>

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

listNodes(request, options, callback)

listNodes(request: protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, protos.google.cloud.compute.v1.INodeGroupsListNodes | null | undefined, protos.google.cloud.compute.v1.INodeGroupNode>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, protos.google.cloud.compute.v1.INodeGroupsListNodes | null | undefined, protos.google.cloud.compute.v1.INodeGroupNode>
Returns
TypeDescription
void

listNodes(request, callback)

listNodes(request: protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, protos.google.cloud.compute.v1.INodeGroupsListNodes | null | undefined, protos.google.cloud.compute.v1.INodeGroupNode>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, protos.google.cloud.compute.v1.INodeGroupsListNodes | null | undefined, protos.google.cloud.compute.v1.INodeGroupNode>
Returns
TypeDescription
void

listNodesAsync(request, options)

listNodesAsync(request?: protos.google.cloud.compute.v1.IListNodesNodeGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.INodeGroupNode>;

Equivalent to listNodes, 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.IListNodesNodeGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [NodeGroupNode]. 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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`." 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" *="" *="" name="" of="" the="" nodegroup="" resource="" whose="" nodes="" you="" want="" to="" list.="" */="" const="" nodegroup='abc123' *="" *="" sorts="" list="" results="" by="" a="" certain="" order.="" by="" default,="" results="" are="" returned="" in="" alphanumerical="" order="" based="" on="" the="" resource="" name.="" you="" can="" also="" sort="" results="" in="" descending="" order="" based="" on="" the="" creation="" timestamp="" using="" `orderby="creationTimestamp desc" `.="" this="" sorts="" results="" based="" on="" the="" `creationtimestamp`="" field="" in="" reverse="" chronological="" order="" (newest="" result="" first).="" use="" this="" to="" sort="" resources="" like="" operations="" so="" that="" the="" newest="" operation="" is="" returned="" first.="" currently,="" only="" sorting="" by="" `name`="" or="" `creationtimestamp="" desc`="" is="" supported.="" */="" const="" orderby='abc123' *="" *="" specifies="" a="" page="" token="" to="" use.="" set="" `pagetoken`="" to="" the="" `nextpagetoken`="" returned="" by="" a="" previous="" list="" request="" to="" get="" the="" next="" page="" of="" results.="" */="" const="" pagetoken='abc123' *="" *="" project="" id="" for="" this="" request.="" */="" const="" project='my-project' *="" *="" 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="" for="" this="" request.="" */="" const="" zone='abc123' imports="" the="" compute="" library="" const="" {nodegroupsclient}="require('@google-cloud/compute').v1;" instantiates="" a="" client="" const="" computeclient="new" nodegroupsclient();="" async="" function="" calllistnodes()="" {="" construct="" request="" const="" request="{" nodegroup,="" project,="" zone,="" };="" run="" request="" const="" iterable="await" computeclient.listnodesasync(request);="" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistnodes();="">

listNodesStream(request, options)

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

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

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

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 [NodeGroupNode] 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 listNodesAsync() 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.IListNodeGroupsRequest, options?: CallOptions): Transform;

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

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

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 [NodeGroup] 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.IPatchNodeGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Updates the specified node group.

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

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.
   */
  /**
   *  Name of the NodeGroup resource to update.
   */
  // const nodeGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const nodeGroupResource = {}
  /**
   *  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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callPatch() {
    // Construct request
    const request = {
      nodeGroup,
      nodeGroupResource,
      project,
      zone,
    };

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

  callPatch();

patch(request, options, callback)

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

patch(request, callback)

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

setIamPolicy(request, options)

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

Sets the access control policy on the specified resource. Replaces any existing policy.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyNodeGroupRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. 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 name of the zone for this request.
   */
  // const zone = 'abc123'
  /**
   *  The body resource for this request
   */
  // const zoneSetPolicyRequestResource = {}

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

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

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

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

  callSetIamPolicy();

setIamPolicy(request, options, callback)

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

setIamPolicy(request, callback)

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

setNodeTemplate(request, options)

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

Updates the node template of the node group.

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

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.
   */
  /**
   *  Name of the NodeGroup resource to update.
   */
  // const nodeGroup = 'abc123'
  /**
   *  The body resource for this request
   */
  // const nodeGroupsSetNodeTemplateRequestResource = {}
  /**
   *  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 for this request.
   */
  // const zone = 'abc123'

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

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

  async function callSetNodeTemplate() {
    // Construct request
    const request = {
      nodeGroup,
      nodeGroupsSetNodeTemplateRequestResource,
      project,
      zone,
    };

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

  callSetNodeTemplate();

setNodeTemplate(request, options, callback)

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

setNodeTemplate(request, callback)

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

testIamPermissions(request, options)

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

Returns permissions that a caller has on the specified resource.

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

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

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

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

testIamPermissions(request, callback)

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