Class v1.NodeGroupControllerClient (5.5.0)

The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of NodeGroupControllerClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

nodeGroupControllerStub

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

batchPath(project, location, batch)

batchPath(project: string, location: string, batch: string): string;

Return a fully-qualified batch resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`batch`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateNodeGroupProgress(name)

checkCreateNodeGroupProgress(name: string): Promise<LROperation<protos.google.cloud.dataproc.v1.NodeGroup, protos.google.cloud.dataproc.v1.NodeGroupOperationMetadata>>;

Check the status of the long running operation returned by createNodeGroup().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataproc.v1.NodeGroup, protos.google.cloud.dataproc.v1.NodeGroupOperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource where this node group will be created.
   *  Format: `projects/{project}/regions/{region}/clusters/{cluster}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The node group to create.
   */
  // const nodeGroup = {}
  /**
   *  Optional. An optional node group ID. Generated if not specified.
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). Cannot begin or end with underscore
   *  or hyphen. Must consist of from 3 to 33 characters.
   */
  // const nodeGroupId = 'abc123'
  /**
   *  Optional. A unique ID used to identify the request. If the server receives
   *  two
   *  CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests)
   *  with the same ID, the second request is ignored and the
   *  first google.longrunning.Operation google.longrunning.Operation  created
   *  and stored in the backend is returned.
   *  Recommendation: Set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new NodeGroupControllerClient();

  async function callCreateNodeGroup() {
    // Construct request
    const request = {
      parent,
      nodeGroup,
    };

    // Run request
    const [operation] = await dataprocClient.createNodeGroup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateNodeGroup();

checkResizeNodeGroupProgress(name)

checkResizeNodeGroupProgress(name: string): Promise<LROperation<protos.google.cloud.dataproc.v1.NodeGroup, protos.google.cloud.dataproc.v1.NodeGroupOperationMetadata>>;

Check the status of the long running operation returned by resizeNodeGroup().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dataproc.v1.NodeGroup, protos.google.cloud.dataproc.v1.NodeGroupOperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the node group to resize.
   *  Format:
   *  `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
   */
  // const name = 'abc123'
  /**
   *  Required. The number of running instances for the node group to maintain.
   *  The group adds or removes instances to maintain the number of instances
   *  specified by this parameter.
   */
  // const size = 1234
  /**
   *  Optional. A unique ID used to identify the request. If the server receives
   *  two
   *  ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests)
   *  with the same ID, the second request is ignored and the
   *  first google.longrunning.Operation google.longrunning.Operation  created
   *  and stored in the backend is returned.
   *  Recommendation: Set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Timeout for graceful YARN decommissioning. Graceful
   *  decommissioning 
   *  (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning)
   *  allows the removal of nodes from the Compute Engine node group
   *  without interrupting jobs in progress. This timeout specifies how long to
   *  wait for jobs in progress to finish before forcefully removing nodes (and
   *  potentially interrupting jobs). Default timeout is 0 (for forceful
   *  decommission), and the maximum allowed timeout is 1 day. (see JSON
   *  representation of
   *  Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
   *  Only supported on Dataproc image versions 1.2 and higher.
   */
  // const gracefulDecommissionTimeout = {}

  // Imports the Dataproc library
  const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new NodeGroupControllerClient();

  async function callResizeNodeGroup() {
    // Construct request
    const request = {
      name,
      size,
    };

    // Run request
    const [operation] = await dataprocClient.resizeNodeGroup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callResizeNodeGroup();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

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

clusterRegionPath(project, region, cluster)

clusterRegionPath(project: string, region: string, cluster: string): string;

Return a fully-qualified clusterRegion resource name string.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`cluster`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

createNodeGroup(request, options)

createNodeGroup(request?: protos.google.cloud.dataproc.v1.ICreateNodeGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a node group in a cluster. The returned Operation.metadata is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

Parameters
Name	Description
`request`	`ICreateNodeGroupRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.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. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource where this node group will be created.
   *  Format: `projects/{project}/regions/{region}/clusters/{cluster}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The node group to create.
   */
  // const nodeGroup = {}
  /**
   *  Optional. An optional node group ID. Generated if not specified.
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). Cannot begin or end with underscore
   *  or hyphen. Must consist of from 3 to 33 characters.
   */
  // const nodeGroupId = 'abc123'
  /**
   *  Optional. A unique ID used to identify the request. If the server receives
   *  two
   *  CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests)
   *  with the same ID, the second request is ignored and the
   *  first google.longrunning.Operation google.longrunning.Operation  created
   *  and stored in the backend is returned.
   *  Recommendation: Set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new NodeGroupControllerClient();

  async function callCreateNodeGroup() {
    // Construct request
    const request = {
      parent,
      nodeGroup,
    };

    // Run request
    const [operation] = await dataprocClient.createNodeGroup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateNodeGroup();

createNodeGroup(request, options, callback)

createNodeGroup(request: protos.google.cloud.dataproc.v1.ICreateNodeGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateNodeGroupRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createNodeGroup(request, callback)

createNodeGroup(request: protos.google.cloud.dataproc.v1.ICreateNodeGroupRequest, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateNodeGroupRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.GetIamPolicyRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.Policy]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getNodeGroup(request, options)

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

Gets the resource representation for a node group in a cluster.

Parameters
Name	Description
`request`	`IGetNodeGroupRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.IGetNodeGroupRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the node group to retrieve.
   *  Format:
   *  `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
   */
  // const name = 'abc123'

  // Imports the Dataproc library
  const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new NodeGroupControllerClient();

  async function callGetNodeGroup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await dataprocClient.getNodeGroup(request);
    console.log(response);
  }

  callGetNodeGroup();

getNodeGroup(request, options, callback)

getNodeGroup(request: protos.google.cloud.dataproc.v1.IGetNodeGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.IGetNodeGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetNodeGroupRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.IGetNodeGroupRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getNodeGroup(request, callback)

getNodeGroup(request: protos.google.cloud.dataproc.v1.IGetNodeGroupRequest, callback: Callback<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.IGetNodeGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetNodeGroupRequest`
`callback`	`Callback<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.IGetNodeGroupRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

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

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

initialize()

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

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

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

Returns
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.ListOperationsResponse>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameter
Name	Description
`projectLocationAutoscalingPolicyName`	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the autoscaling_policy.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameter
Name	Description
`projectRegionAutoscalingPolicyName`	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the autoscaling_policy.

matchBatchFromBatchName(batchName)

matchBatchFromBatchName(batchName: string): string | number;

Parse the batch from Batch resource.

Parameter
Name	Description
`batchName`	`string` A fully-qualified path representing Batch resource.

Returns
Type	Description
`string \| number`	{string} A string representing the batch.

matchClusterFromClusterRegionName(clusterRegionName)

matchClusterFromClusterRegionName(clusterRegionName: string): string | number;

Parse the cluster from ClusterRegion resource.

Parameter
Name	Description
`clusterRegionName`	`string` A fully-qualified path representing ClusterRegion resource.

Returns
Type	Description
`string \| number`	{string} A string representing the cluster.

matchClusterFromNodeGroupName(nodeGroupName)

matchClusterFromNodeGroupName(nodeGroupName: string): string | number;

Parse the cluster from NodeGroup resource.

Parameter
Name	Description
`nodeGroupName`	`string` A fully-qualified path representing NodeGroup resource.

Returns
Type	Description
`string \| number`	{string} A string representing the cluster.

matchLocationFromBatchName(batchName)

matchLocationFromBatchName(batchName: string): string | number;

Parse the location from Batch resource.

Parameter
Name	Description
`batchName`	`string` A fully-qualified path representing Batch resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameter
Name	Description
`projectLocationAutoscalingPolicyName`	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameter
Name	Description
`projectLocationWorkflowTemplateName`	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSessionName(sessionName)

matchLocationFromSessionName(sessionName: string): string | number;

Parse the location from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSessionTemplateName(sessionTemplateName)

matchLocationFromSessionTemplateName(sessionTemplateName: string): string | number;

Parse the location from SessionTemplate resource.

Parameter
Name	Description
`sessionTemplateName`	`string` A fully-qualified path representing SessionTemplate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchNodeGroupFromNodeGroupName(nodeGroupName)

matchNodeGroupFromNodeGroupName(nodeGroupName: string): string | number;

Parse the node_group from NodeGroup resource.

Parameter
Name	Description
`nodeGroupName`	`string` A fully-qualified path representing NodeGroup resource.

Returns
Type	Description
`string \| number`	{string} A string representing the node_group.

matchProjectFromBatchName(batchName)

matchProjectFromBatchName(batchName: string): string | number;

Parse the project from Batch resource.

Parameter
Name	Description
`batchName`	`string` A fully-qualified path representing Batch resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromClusterRegionName(clusterRegionName)

matchProjectFromClusterRegionName(clusterRegionName: string): string | number;

Parse the project from ClusterRegion resource.

Parameter
Name	Description
`clusterRegionName`	`string` A fully-qualified path representing ClusterRegion resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromNodeGroupName(nodeGroupName)

matchProjectFromNodeGroupName(nodeGroupName: string): string | number;

Parse the project from NodeGroup resource.

Parameter
Name	Description
`nodeGroupName`	`string` A fully-qualified path representing NodeGroup resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameter
Name	Description
`projectLocationAutoscalingPolicyName`	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameter
Name	Description
`projectLocationWorkflowTemplateName`	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameter
Name	Description
`projectRegionAutoscalingPolicyName`	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameter
Name	Description
`projectRegionWorkflowTemplateName`	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromRegionName(regionName)

matchProjectFromRegionName(regionName: string): string | number;

Parse the project from Region resource.

Parameter
Name	Description
`regionName`	`string` A fully-qualified path representing Region resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSessionName(sessionName)

matchProjectFromSessionName(sessionName: string): string | number;

Parse the project from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSessionTemplateName(sessionTemplateName)

matchProjectFromSessionTemplateName(sessionTemplateName: string): string | number;

Parse the project from SessionTemplate resource.

Parameter
Name	Description
`sessionTemplateName`	`string` A fully-qualified path representing SessionTemplate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchRegionFromClusterRegionName(clusterRegionName)

matchRegionFromClusterRegionName(clusterRegionName: string): string | number;

Parse the region from ClusterRegion resource.

Parameter
Name	Description
`clusterRegionName`	`string` A fully-qualified path representing ClusterRegion resource.

Returns
Type	Description
`string \| number`	{string} A string representing the region.

matchRegionFromNodeGroupName(nodeGroupName)

matchRegionFromNodeGroupName(nodeGroupName: string): string | number;

Parse the region from NodeGroup resource.

Parameter
Name	Description
`nodeGroupName`	`string` A fully-qualified path representing NodeGroup resource.

Returns
Type	Description
`string \| number`	{string} A string representing the region.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameter
Name	Description
`projectRegionAutoscalingPolicyName`	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the region.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameter
Name	Description
`projectRegionWorkflowTemplateName`	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the region.

matchRegionFromRegionName(regionName)

matchRegionFromRegionName(regionName: string): string | number;

Parse the region from Region resource.

Parameter
Name	Description
`regionName`	`string` A fully-qualified path representing Region resource.

Returns
Type	Description
`string \| number`	{string} A string representing the region.

matchSessionFromSessionName(sessionName)

matchSessionFromSessionName(sessionName: string): string | number;

Parse the session from Session resource.

Parameter
Name	Description
`sessionName`	`string` A fully-qualified path representing Session resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchTemplateFromSessionTemplateName(sessionTemplateName)

matchTemplateFromSessionTemplateName(sessionTemplateName: string): string | number;

Parse the template from SessionTemplate resource.

Parameter
Name	Description
`sessionTemplateName`	`string` A fully-qualified path representing SessionTemplate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the template.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameter
Name	Description
`projectLocationWorkflowTemplateName`	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the workflow_template.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameter
Name	Description
`projectRegionWorkflowTemplateName`	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns
Type	Description
`string \| number`	{string} A string representing the workflow_template.

nodeGroupPath(project, region, cluster, nodeGroup)

nodeGroupPath(project: string, region: string, cluster: string, nodeGroup: string): string;

Return a fully-qualified nodeGroup resource name string.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`cluster`	`string`
`nodeGroup`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

projectLocationAutoscalingPolicyPath(project: string, location: string, autoscalingPolicy: string): string;

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`autoscalingPolicy`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

projectLocationWorkflowTemplatePath(project: string, location: string, workflowTemplate: string): string;

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`workflowTemplate`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

projectRegionAutoscalingPolicyPath(project: string, region: string, autoscalingPolicy: string): string;

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`autoscalingPolicy`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): string;

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`workflowTemplate`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

regionPath(project, region)

regionPath(project: string, region: string): string;

Return a fully-qualified region resource name string.

Parameters
Name	Description
`project`	`string`
`region`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

resizeNodeGroup(request, options)

resizeNodeGroup(request?: protos.google.cloud.dataproc.v1.IResizeNodeGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Resizes a node group in a cluster. The returned Operation.metadata is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

Parameters
Name	Description
`request`	`IResizeNodeGroupRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.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. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the node group to resize.
   *  Format:
   *  `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
   */
  // const name = 'abc123'
  /**
   *  Required. The number of running instances for the node group to maintain.
   *  The group adds or removes instances to maintain the number of instances
   *  specified by this parameter.
   */
  // const size = 1234
  /**
   *  Optional. A unique ID used to identify the request. If the server receives
   *  two
   *  ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests)
   *  with the same ID, the second request is ignored and the
   *  first google.longrunning.Operation google.longrunning.Operation  created
   *  and stored in the backend is returned.
   *  Recommendation: Set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The ID must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Timeout for graceful YARN decommissioning. Graceful
   *  decommissioning 
   *  (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning)
   *  allows the removal of nodes from the Compute Engine node group
   *  without interrupting jobs in progress. This timeout specifies how long to
   *  wait for jobs in progress to finish before forcefully removing nodes (and
   *  potentially interrupting jobs). Default timeout is 0 (for forceful
   *  decommission), and the maximum allowed timeout is 1 day. (see JSON
   *  representation of
   *  Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
   *  Only supported on Dataproc image versions 1.2 and higher.
   */
  // const gracefulDecommissionTimeout = {}

  // Imports the Dataproc library
  const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new NodeGroupControllerClient();

  async function callResizeNodeGroup() {
    // Construct request
    const request = {
      name,
      size,
    };

    // Run request
    const [operation] = await dataprocClient.resizeNodeGroup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callResizeNodeGroup();

resizeNodeGroup(request, options, callback)

resizeNodeGroup(request: protos.google.cloud.dataproc.v1.IResizeNodeGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IResizeNodeGroupRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

resizeNodeGroup(request, callback)

resizeNodeGroup(request: protos.google.cloud.dataproc.v1.IResizeNodeGroupRequest, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IResizeNodeGroupRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dataproc.v1.INodeGroup, protos.google.cloud.dataproc.v1.INodeGroupOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

sessionPath(project, location, session)

sessionPath(project: string, location: string, session: string): string;

Return a fully-qualified session resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`session`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

sessionTemplatePath(project, location, template)

sessionTemplatePath(project: string, location: string, template: string): string;

Return a fully-qualified sessionTemplate resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`template`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.SetIamPolicyRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.Policy]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.TestIamPermissionsRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.TestIamPermissionsResponse]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.