Class v1.AwsClustersClient (0.1.4)

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure. v1

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AwsClustersClient.

Parameters

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

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

awsClustersStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [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.

warn

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

Methods

awsClusterPath(project, location, awsCluster)

awsClusterPath(project: string, location: string, awsCluster: string): string;

Return a fully-qualified awsCluster resource name string.

Parameters

Name	Description
project	`string`
location	`string`
awsCluster	`string`

Returns

Type	Description
string	{string} Resource name string.

awsNodePoolPath(project, location, awsCluster, awsNodePool)

awsNodePoolPath(project: string, location: string, awsCluster: string, awsNodePool: string): string;

Return a fully-qualified awsNodePool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
awsCluster	`string`
awsNodePool	`string`

Returns

Type	Description
string	{string} Resource name string.

awsServerConfigPath(project, location)

awsServerConfigPath(project: string, location: string): string;

Return a fully-qualified awsServerConfig resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

azureClientPath(project, location, azureClient)

azureClientPath(project: string, location: string, azureClient: string): string;

Return a fully-qualified azureClient resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureClient	`string`

Returns

Type	Description
string	{string} Resource name string.

azureClusterPath(project, location, azureCluster)

azureClusterPath(project: string, location: string, azureCluster: string): string;

Return a fully-qualified azureCluster resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureCluster	`string`

Returns

Type	Description
string	{string} Resource name string.

azureNodePoolPath(project, location, azureCluster, azureNodePool)

azureNodePoolPath(project: string, location: string, azureCluster: string, azureNodePool: string): string;

Return a fully-qualified azureNodePool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureCluster	`string`
azureNodePool	`string`

Returns

Type	Description
string	{string} Resource name string.

azureServerConfigPath(project, location)

azureServerConfigPath(project: string, location: string): string;

Return a fully-qualified azureServerConfig resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

checkCreateAwsClusterProgress(name)

checkCreateAwsClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 location where this AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource
   *  will be created.
   *  Location names are formatted as `projects/

checkCreateAwsNodePoolProgress(name)

checkCreateAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource where this node pool will be created.
   *  `AwsCluster` names are formatted as
   *  `projects/

checkDeleteAwsClusterProgress(name)

checkDeleteAwsClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 resource name the AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  to delete.
   *  `AwsCluster` names are formatted as
   *  `projects/

checkDeleteAwsNodePoolProgress(name)

checkDeleteAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 resource name the AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  to delete.
   *  `AwsNodePool` names are formatted as
   *  `projects/

checkUpdateAwsClusterProgress(name)

checkUpdateAwsClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource to update.
   */
  // const awsCluster = {}
  /**
   *  If set, only validate the request, but do not actually update the cluster.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AwsCluster google.cloud.gkemulticloud.v1.AwsCluster:
   *   *   `description`.
   *   *   `annotations`.
   *   *   `control_plane.version`.
   *   *   `authorization.admin_users`.
   *   *   `control_plane.aws_services_authentication.role_arn`.
   *   *   `control_plane.aws_services_authentication.role_session_name`.
   *   *   `control_plane.config_encryption.kms_key_arn`.
   *   *   `control_plane.instance_type`.
   *   *   `control_plane.security_group_ids`.
   *   *   `control_plane.proxy_config`.
   *   *   `control_plane.proxy_config.secret_arn`.
   *   *   `control_plane.proxy_config.secret_version`.
   *   *   `control_plane.root_volume.iops`.
   *   *   `control_plane.root_volume.kms_key_arn`.
   *   *   `control_plane.root_volume.volume_type`.
   *   *   `control_plane.root_volume.size_gib`.
   *   *   `control_plane.ssh_config`.
   *   *   `control_plane.ssh_config.ec2_key_pair`.
   *   *   `control_plane.instance_placement.tenancy`.
   *   *   `logging_config`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AwsClustersClient();

  async function callUpdateAwsCluster() {
    // Construct request
    const request = {
      awsCluster,
      updateMask,
    };

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

  callUpdateAwsCluster();

checkUpdateAwsNodePoolProgress(name)

checkUpdateAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  resource to update.
   */
  // const awsNodePool = {}
  /**
   *  If set, only validate the request, but don't actually update the node pool.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool:
   *   *   `annotations`.
   *   *   `version`.
   *   *   `autoscaling.min_node_count`.
   *   *   `autoscaling.max_node_count`.
   *   *   `config.config_encryption.kms_key_arn`.
   *   *   `config.security_group_ids`.
   *   *   `config.root_volume.iops`.
   *   *   `config.root_volume.kms_key_arn`.
   *   *   `config.root_volume.volume_type`.
   *   *   `config.root_volume.size_gib`.
   *   *   `config.proxy_config`.
   *   *   `config.proxy_config.secret_arn`.
   *   *   `config.proxy_config.secret_version`.
   *   *   `config.ssh_config`.
   *   *   `config.ssh_config.ec2_key_pair`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AwsClustersClient();

  async function callUpdateAwsNodePool() {
    // Construct request
    const request = {
      awsNodePool,
      updateMask,
    };

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

  callUpdateAwsNodePool();

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.

createAwsCluster(request, options)

createAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new resource on a given GCP project and region.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 location where this AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource
   *  will be created.
   *  Location names are formatted as `projects/

createAwsCluster(request, options, callback)

createAwsCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAwsCluster(request, callback)

createAwsCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAwsNodePool(request, options)

createAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new , attached to a given .

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource where this node pool will be created.
   *  `AwsCluster` names are formatted as
   *  `projects/

createAwsNodePool(request, options, callback)

createAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAwsNodePool(request, callback)

createAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAwsCluster(request, options)

deleteAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a specific resource.

Fails if the cluster has one or more associated resources.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 resource name the AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  to delete.
   *  `AwsCluster` names are formatted as
   *  `projects/

deleteAwsCluster(request, options, callback)

deleteAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAwsCluster(request, callback)

deleteAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAwsNodePool(request, options)

deleteAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a specific resource.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 resource name the AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  to delete.
   *  `AwsNodePool` names are formatted as
   *  `projects/

deleteAwsNodePool(request, options, callback)

deleteAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAwsNodePool(request, callback)

deleteAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateAwsAccessToken(request, options)

generateAwsAccessToken(request?: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse,
        (protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | undefined),
        {} | undefined
    ]>;

Generates a short-lived access token to authenticate to a given resource.

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, (protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest \| undefined), {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [GenerateAwsAccessTokenResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource to authenticate to.
   *  `AwsCluster` names are formatted as
   *  `projects/

generateAwsAccessToken(request, options, callback)

generateAwsAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateAwsAccessToken(request, callback)

generateAwsAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsCluster(request, options)

getAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAwsCluster,
        protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | undefined,
        {} | undefined
    ]>;

Describes a specific resource.

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AwsCluster]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource to describe.
   *  `AwsCluster` names are formatted as
   *  `projects/

getAwsCluster(request, options, callback)

getAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsCluster(request, callback)

getAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsNodePool(request, options)

getAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAwsNodePool,
        protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | undefined,
        {} | undefined
    ]>;

Describes a specific resource.

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AwsNodePool]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  resource to describe.
   *  `AwsNodePool` names are formatted as
   *  `projects/

getAwsNodePool(request, options, callback)

getAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsNodePool(request, callback)

getAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsServerConfig(request, options)

getAwsServerConfig(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAwsServerConfig,
        (protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | undefined),
        {} | undefined
    ]>;

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, (protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest \| undefined), {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AwsServerConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the AwsServerConfig google.cloud.gkemulticloud.v1.AwsServerConfig  resource to describe.
   *  `AwsServerConfig` names are formatted as
   *  `projects/

getAwsServerConfig(request, options, callback)

getAwsServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAwsServerConfig(request, callback)

getAwsServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

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

Parameter

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

Returns

Type	Description
void

initialize()

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

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

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

Returns

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

listAwsClusters(request, options)

listAwsClusters(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAwsCluster[],
        protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest | null,
        protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse
    ]>;

Lists all resources on a given Google Cloud project and region.

Parameters

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

Returns

Type Description

Promise<[ protos.google.cloud.gkemulticloud.v1.IAwsCluster[], protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest | null, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse ]>

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

listAwsClusters(request, options, callback)

listAwsClusters(request: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>`

Returns

Type	Description
void

listAwsClusters(request, callback)

listAwsClusters(request: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>`

Returns

Type	Description
void

listAwsClustersAsync(request, options)

listAwsClustersAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsCluster>;

Equivalent to listAwsClusters, but returns an iterable object.

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

Parameters

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

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsCluster>

{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 [AwsCluster]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent location which owns this collection of
   *  AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resources.
   *  Location names are formatted as `projects/

listAwsClustersStream(request, options)

listAwsClustersStream(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): Transform;

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

Parameters

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

Returns

Type Description

Transform

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

listAwsNodePools(request, options)

listAwsNodePools(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAwsNodePool[],
        protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest | null,
        protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse
    ]>;

Lists all resources on a given .

Parameters

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

Returns

Type Description

Promise<[ protos.google.cloud.gkemulticloud.v1.IAwsNodePool[], protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest | null, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse ]>

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

listAwsNodePools(request, options, callback)

listAwsNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>`

Returns

Type	Description
void

listAwsNodePools(request, callback)

listAwsNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>`

Returns

Type	Description
void

listAwsNodePoolsAsync(request, options)

listAwsNodePoolsAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsNodePool>;

Equivalent to listAwsNodePools, but returns an iterable object.

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

Parameters

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

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsNodePool>

{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 [AwsNodePool]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent `AwsCluster` which owns this collection of
   *  AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  resources.
   *  `AwsCluster` names are formatted as
   *  `projects/

listAwsNodePoolsStream(request, options)

listAwsNodePoolsStream(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): Transform;

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

Parameters

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

Returns

Type Description

Transform

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

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAwsClusterFromAwsClusterName(awsClusterName)

matchAwsClusterFromAwsClusterName(awsClusterName: string): string | number;

Parse the aws_cluster from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_cluster.

matchAwsClusterFromAwsNodePoolName(awsNodePoolName)

matchAwsClusterFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the aws_cluster from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_cluster.

matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName)

matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the aws_node_pool from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_node_pool.

matchAzureClientFromAzureClientName(azureClientName)

matchAzureClientFromAzureClientName(azureClientName: string): string | number;

Parse the azure_client from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_client.

matchAzureClusterFromAzureClusterName(azureClusterName)

matchAzureClusterFromAzureClusterName(azureClusterName: string): string | number;

Parse the azure_cluster from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_cluster.

matchAzureClusterFromAzureNodePoolName(azureNodePoolName)

matchAzureClusterFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the azure_cluster from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_cluster.

matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName)

matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the azure_node_pool from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_node_pool.

matchLocationFromAwsClusterName(awsClusterName)

matchLocationFromAwsClusterName(awsClusterName: string): string | number;

Parse the location from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

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

matchLocationFromAwsNodePoolName(awsNodePoolName)

matchLocationFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the location from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

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

matchLocationFromAwsServerConfigName(awsServerConfigName)

matchLocationFromAwsServerConfigName(awsServerConfigName: string): string | number;

Parse the location from AwsServerConfig resource.

Parameter

Name	Description
awsServerConfigName	`string` A fully-qualified path representing AwsServerConfig resource.

Returns

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

matchLocationFromAzureClientName(azureClientName)

matchLocationFromAzureClientName(azureClientName: string): string | number;

Parse the location from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

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

matchLocationFromAzureClusterName(azureClusterName)

matchLocationFromAzureClusterName(azureClusterName: string): string | number;

Parse the location from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

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

matchLocationFromAzureNodePoolName(azureNodePoolName)

matchLocationFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the location from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

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

matchLocationFromAzureServerConfigName(azureServerConfigName)

matchLocationFromAzureServerConfigName(azureServerConfigName: string): string | number;

Parse the location from AzureServerConfig resource.

Parameter

Name	Description
azureServerConfigName	`string` A fully-qualified path representing AzureServerConfig resource.

Returns

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

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

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

matchProjectFromAwsClusterName(awsClusterName)

matchProjectFromAwsClusterName(awsClusterName: string): string | number;

Parse the project from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

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

matchProjectFromAwsNodePoolName(awsNodePoolName)

matchProjectFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the project from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

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

matchProjectFromAwsServerConfigName(awsServerConfigName)

matchProjectFromAwsServerConfigName(awsServerConfigName: string): string | number;

Parse the project from AwsServerConfig resource.

Parameter

Name	Description
awsServerConfigName	`string` A fully-qualified path representing AwsServerConfig resource.

Returns

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

matchProjectFromAzureClientName(azureClientName)

matchProjectFromAzureClientName(azureClientName: string): string | number;

Parse the project from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

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

matchProjectFromAzureClusterName(azureClusterName)

matchProjectFromAzureClusterName(azureClusterName: string): string | number;

Parse the project from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

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

matchProjectFromAzureNodePoolName(azureNodePoolName)

matchProjectFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the project from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

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

matchProjectFromAzureServerConfigName(azureServerConfigName)

matchProjectFromAzureServerConfigName(azureServerConfigName: string): string | number;

Parse the project from AzureServerConfig resource.

Parameter

Name	Description
azureServerConfigName	`string` A fully-qualified path representing AzureServerConfig resource.

Returns

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

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location 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.

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.

updateAwsCluster(request, options)

updateAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an .

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resource to update.
   */
  // const awsCluster = {}
  /**
   *  If set, only validate the request, but do not actually update the cluster.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AwsCluster google.cloud.gkemulticloud.v1.AwsCluster:
   *   *   `description`.
   *   *   `annotations`.
   *   *   `control_plane.version`.
   *   *   `authorization.admin_users`.
   *   *   `control_plane.aws_services_authentication.role_arn`.
   *   *   `control_plane.aws_services_authentication.role_session_name`.
   *   *   `control_plane.config_encryption.kms_key_arn`.
   *   *   `control_plane.instance_type`.
   *   *   `control_plane.security_group_ids`.
   *   *   `control_plane.proxy_config`.
   *   *   `control_plane.proxy_config.secret_arn`.
   *   *   `control_plane.proxy_config.secret_version`.
   *   *   `control_plane.root_volume.iops`.
   *   *   `control_plane.root_volume.kms_key_arn`.
   *   *   `control_plane.root_volume.volume_type`.
   *   *   `control_plane.root_volume.size_gib`.
   *   *   `control_plane.ssh_config`.
   *   *   `control_plane.ssh_config.ec2_key_pair`.
   *   *   `control_plane.instance_placement.tenancy`.
   *   *   `logging_config`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AwsClustersClient();

  async function callUpdateAwsCluster() {
    // Construct request
    const request = {
      awsCluster,
      updateMask,
    };

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

  callUpdateAwsCluster();

updateAwsCluster(request, options, callback)

updateAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAwsCluster(request, callback)

updateAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAwsNodePool(request, options)

updateAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an .

Parameters

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

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool  resource to update.
   */
  // const awsNodePool = {}
  /**
   *  If set, only validate the request, but don't actually update the node pool.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool:
   *   *   `annotations`.
   *   *   `version`.
   *   *   `autoscaling.min_node_count`.
   *   *   `autoscaling.max_node_count`.
   *   *   `config.config_encryption.kms_key_arn`.
   *   *   `config.security_group_ids`.
   *   *   `config.root_volume.iops`.
   *   *   `config.root_volume.kms_key_arn`.
   *   *   `config.root_volume.volume_type`.
   *   *   `config.root_volume.size_gib`.
   *   *   `config.proxy_config`.
   *   *   `config.proxy_config.secret_arn`.
   *   *   `config.proxy_config.secret_version`.
   *   *   `config.ssh_config`.
   *   *   `config.ssh_config.ec2_key_pair`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AwsClustersClient();

  async function callUpdateAwsNodePool() {
    // Construct request
    const request = {
      awsNodePool,
      updateMask,
    };

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

  callUpdateAwsNodePool();

updateAwsNodePool(request, options, callback)

updateAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAwsNodePool(request, callback)

updateAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void