Class v1.EdgeContainerClient (0.3.0)

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of EdgeContainerClient.

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 EdgeContainerClient({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;

edgeContainerStub

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

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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

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: ''});

checkCreateClusterProgress(name)

checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.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 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 cluster will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. A client-specified unique identifier for the cluster.
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The cluster to create.
   */
  // const cluster = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateCluster() {
    // Construct request
    const request = {
      parent,
      clusterId,
      cluster,
    };

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

  callCreateCluster();

checkCreateNodePoolProgress(name)

checkCreateNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.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 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 cluster where this node pool will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. A client-specified unique identifier for the node pool.
   */
  // const nodePoolId = 'abc123'
  /**
   *  Required. The node pool to create.
   */
  // const nodePool = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateNodePool() {
    // Construct request
    const request = {
      parent,
      nodePoolId,
      nodePool,
    };

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

  callCreateNodePool();

checkCreateVpnConnectionProgress(name)

checkCreateVpnConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.VpnConnection, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.VpnConnection, protos.google.cloud.edgecontainer.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 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 vpn connection will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. The VPN connection identifier.
   */
  // const vpnConnectionId = 'abc123'
  /**
   *  Required. The VPN connection to create.
   */
  // const vpnConnection = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateVpnConnection() {
    // Construct request
    const request = {
      parent,
      vpnConnectionId,
      vpnConnection,
    };

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

  callCreateVpnConnection();

checkDeleteClusterProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.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 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 of the cluster.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteCluster();

checkDeleteNodePoolProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.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 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 of the node pool.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteNodePool();

checkDeleteVpnConnectionProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.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 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 of the vpn connection.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteVpnConnection();

checkUpdateClusterProgress(name)

checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.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 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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  Cluster resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  The updated cluster.
   */
  // const cluster = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters.
   *  A random UUID is recommended.
   *  This request is only idempotent if `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callUpdateCluster() {
    // Construct request
    const request = {
    };

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

  callUpdateCluster();

checkUpdateNodePoolProgress(name)

checkUpdateNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.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 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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  NodePool resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  The updated node pool.
   */
  // const nodePool = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callUpdateNodePool() {
    // Construct request
    const request = {
    };

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

  callUpdateNodePool();

checkUpgradeClusterProgress(name)

checkUpgradeClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.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 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 of the cluster.
   */
  // const name = 'abc123'
  /**
   *  Required. The version the cluster is going to be upgraded to.
   */
  // const targetVersion = 'abc123'
  /**
   *  The schedule for the upgrade.
   */
  // const schedule = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callUpgradeCluster();

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.

clusterPath(project, location, cluster)

clusterPath(project: string, location: string, cluster: string): string;

Return a fully-qualified cluster resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`cluster`	`string`

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

createCluster(request, options)

createCluster(request?: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Cluster in a given project and location.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.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 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 cluster will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. A client-specified unique identifier for the cluster.
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The cluster to create.
   */
  // const cluster = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateCluster() {
    // Construct request
    const request = {
      parent,
      clusterId,
      cluster,
    };

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

  callCreateCluster();

createCluster(request, options, callback)

createCluster(request: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateClusterRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createCluster(request, callback)

createCluster(request: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateClusterRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createNodePool(request, options)

createNodePool(request?: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new NodePool in a given project and location.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.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 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 cluster where this node pool will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. A client-specified unique identifier for the node pool.
   */
  // const nodePoolId = 'abc123'
  /**
   *  Required. The node pool to create.
   */
  // const nodePool = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateNodePool() {
    // Construct request
    const request = {
      parent,
      nodePoolId,
      nodePool,
    };

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

  callCreateNodePool();

createNodePool(request, options, callback)

createNodePool(request: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateNodePoolRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createNodePool(request, callback)

createNodePool(request: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateNodePoolRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createVpnConnection(request, options)

createVpnConnection(request?: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new VPN connection in a given project and location.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.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 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 vpn connection will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. The VPN connection identifier.
   */
  // const vpnConnectionId = 'abc123'
  /**
   *  Required. The VPN connection to create.
   */
  // const vpnConnection = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callCreateVpnConnection() {
    // Construct request
    const request = {
      parent,
      vpnConnectionId,
      vpnConnection,
    };

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

  callCreateVpnConnection();

createVpnConnection(request, options, callback)

createVpnConnection(request: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateVpnConnectionRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createVpnConnection(request, callback)

createVpnConnection(request: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateVpnConnectionRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteCluster(request, options)

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

Deletes a single Cluster.

Parameters
Name	Description
`request`	`IDeleteClusterRequest` 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.edgecontainer.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 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 of the cluster.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteCluster();

deleteCluster(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteCluster(request, callback)

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

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

Returns
Type	Description
`void`

deleteNodePool(request, options)

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

Deletes a single NodePool.

Parameters
Name	Description
`request`	`IDeleteNodePoolRequest` 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.edgecontainer.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 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 of the node pool.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteNodePool();

deleteNodePool(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteNodePool(request, callback)

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

Parameters
Name	Description
`request`	`IDeleteNodePoolRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, 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: ''});

deleteVpnConnection(request, options)

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

Deletes a single VPN connection.

Parameters
Name	Description
`request`	`IDeleteVpnConnectionRequest` 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.edgecontainer.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 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 of the vpn connection.
   */
  // const name = 'abc123'
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callDeleteVpnConnection();

deleteVpnConnection(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteVpnConnection(request, callback)

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

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

Returns
Type	Description
`void`

generateAccessToken(request, options)

generateAccessToken(request?: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse,
        (protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | undefined),
        {} | undefined
    ]>;

Generates an access token for a Cluster.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, (protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateAccessTokenResponse. 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 resource name of the cluster.
   */
  // const cluster = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callGenerateAccessToken() {
    // Construct request
    const request = {
      cluster,
    };

    // Run request
    const response = await edgecontainerClient.generateAccessToken(request);
    console.log(response);
  }

  callGenerateAccessToken();

generateAccessToken(request, options, callback)

generateAccessToken(request: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGenerateAccessTokenRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

generateAccessToken(request, callback)

generateAccessToken(request: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGenerateAccessTokenRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

generateOfflineCredential(request, options)

generateOfflineCredential(request?: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse,
        (protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | undefined),
        {} | undefined
    ]>;

Generates an offline credential for a Cluster.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, (protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateOfflineCredentialResponse. 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 resource name of the cluster.
   */
  // const cluster = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callGenerateOfflineCredential() {
    // Construct request
    const request = {
      cluster,
    };

    // Run request
    const response = await edgecontainerClient.generateOfflineCredential(request);
    console.log(response);
  }

  callGenerateOfflineCredential();

generateOfflineCredential(request, options, callback)

generateOfflineCredential(request: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGenerateOfflineCredentialRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

generateOfflineCredential(request, callback)

generateOfflineCredential(request: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGenerateOfflineCredentialRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCluster(request, options)

getCluster(request?: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.ICluster,
        protos.google.cloud.edgecontainer.v1.IGetClusterRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Cluster.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest \| 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 resource name of the cluster.
   */
  // const name = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

    // Run request
    const response = await edgecontainerClient.getCluster(request);
    console.log(response);
  }

  callGetCluster();

getCluster(request, options, callback)

getCluster(request: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetClusterRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCluster(request, callback)

getCluster(request: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetClusterRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{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


const [response] = await client.getLocation(request);

getMachine(request, options)

getMachine(request?: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IMachine,
        protos.google.cloud.edgecontainer.v1.IGetMachineRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Machine.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Machine. 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 resource name of the machine.
   */
  // const name = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

    // Run request
    const response = await edgecontainerClient.getMachine(request);
    console.log(response);
  }

  callGetMachine();

getMachine(request, options, callback)

getMachine(request: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMachineRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getMachine(request, callback)

getMachine(request: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMachineRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getNodePool(request, options)

getNodePool(request?: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.INodePool,
        protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single NodePool.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest \| 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 resource name of the node pool.
   */
  // const name = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

    // Run request
    const response = await edgecontainerClient.getNodePool(request);
    console.log(response);
  }

  callGetNodePool();

getNodePool(request, options, callback)

getNodePool(request: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetNodePoolRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getNodePool(request, callback)

getNodePool(request: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetNodePoolRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest \| 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`

getServerConfig(request, options)

getServerConfig(request?: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IServerConfig,
        protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | undefined,
        {} | undefined
    ]>;

Gets the server config.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ServerConfig. 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 (project and location) of the server config to get,
   *  specified in the format `projects/* /locations/*`.
   */
  // const name = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

    // Run request
    const response = await edgecontainerClient.getServerConfig(request);
    console.log(response);
  }

  callGetServerConfig();

getServerConfig(request, options, callback)

getServerConfig(request: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetServerConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getServerConfig(request, callback)

getServerConfig(request: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetServerConfigRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVpnConnection(request, options)

getVpnConnection(request?: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IVpnConnection,
        protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single VPN connection.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest \| 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 resource name of the vpn connection.
   */
  // const name = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

    // Run request
    const response = await edgecontainerClient.getVpnConnection(request);
    console.log(response);
  }

  callGetVpnConnection();

getVpnConnection(request, options, callback)

getVpnConnection(request: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetVpnConnectionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVpnConnection(request, callback)

getVpnConnection(request: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetVpnConnectionRequest`
`callback`	`Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest \| null \| undefined, {} \| null \| 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.

listClusters(request, options)

listClusters(request?: protos.google.cloud.edgecontainer.v1.IListClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.ICluster[],
        protos.google.cloud.edgecontainer.v1.IListClustersRequest | null,
        protos.google.cloud.edgecontainer.v1.IListClustersResponse
    ]>;

Lists Clusters in a given project and location.

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

Returns

Type Description

Promise<[
        protos.google.cloud.edgecontainer.v1.ICluster[],
        protos.google.cloud.edgecontainer.v1.IListClustersRequest | null,
        protos.google.cloud.edgecontainer.v1.IListClustersResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listClustersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listClusters(request, options, callback)

listClusters(request: protos.google.cloud.edgecontainer.v1.IListClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListClustersRequest, protos.google.cloud.edgecontainer.v1.IListClustersResponse | null | undefined, protos.google.cloud.edgecontainer.v1.ICluster>): void;

Parameters
Name	Description
`request`	`IListClustersRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListClustersRequest, protos.google.cloud.edgecontainer.v1.IListClustersResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.ICluster>`

Returns
Type	Description
`void`

listClusters(request, callback)

listClusters(request: protos.google.cloud.edgecontainer.v1.IListClustersRequest, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListClustersRequest, protos.google.cloud.edgecontainer.v1.IListClustersResponse | null | undefined, protos.google.cloud.edgecontainer.v1.ICluster>): void;

Parameters
Name	Description
`request`	`IListClustersRequest`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListClustersRequest, protos.google.cloud.edgecontainer.v1.IListClustersResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.ICluster>`

Returns
Type	Description
`void`

listClustersAsync(request, options)

listClustersAsync(request?: protos.google.cloud.edgecontainer.v1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgecontainer.v1.ICluster>;

Equivalent to listClusters, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.edgecontainer.v1.ICluster>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 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 clusters.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to list.
   */
  // const pageSize = 1234
  /**
   *  A page token received from previous list request.
   *  A page token received from previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Only resources matching this filter will be listed.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the order in which resources will be listed.
   */
  // const orderBy = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callListClusters();

listClustersStream(request, options)

listClustersStream(request?: protos.google.cloud.edgecontainer.v1.IListClustersRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListClustersRequest` 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 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 `listClustersAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example


const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listMachines(request, options)

listMachines(request?: protos.google.cloud.edgecontainer.v1.IListMachinesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IMachine[],
        protos.google.cloud.edgecontainer.v1.IListMachinesRequest | null,
        protos.google.cloud.edgecontainer.v1.IListMachinesResponse
    ]>;

Lists Machines in a given project and location.

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

Returns

Type Description

Promise<[
        protos.google.cloud.edgecontainer.v1.IMachine[],
        protos.google.cloud.edgecontainer.v1.IListMachinesRequest | null,
        protos.google.cloud.edgecontainer.v1.IListMachinesResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Machine. 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 listMachinesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMachines(request, options, callback)

listMachines(request: protos.google.cloud.edgecontainer.v1.IListMachinesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListMachinesRequest, protos.google.cloud.edgecontainer.v1.IListMachinesResponse | null | undefined, protos.google.cloud.edgecontainer.v1.IMachine>): void;

Parameters
Name	Description
`request`	`IListMachinesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListMachinesRequest, protos.google.cloud.edgecontainer.v1.IListMachinesResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.IMachine>`

Returns
Type	Description
`void`

listMachines(request, callback)

listMachines(request: protos.google.cloud.edgecontainer.v1.IListMachinesRequest, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListMachinesRequest, protos.google.cloud.edgecontainer.v1.IListMachinesResponse | null | undefined, protos.google.cloud.edgecontainer.v1.IMachine>): void;

Parameters
Name	Description
`request`	`IListMachinesRequest`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListMachinesRequest, protos.google.cloud.edgecontainer.v1.IListMachinesResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.IMachine>`

Returns
Type	Description
`void`

listMachinesAsync(request, options)

listMachinesAsync(request?: protos.google.cloud.edgecontainer.v1.IListMachinesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgecontainer.v1.IMachine>;

Equivalent to listMachines, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.edgecontainer.v1.IMachine>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Machine. 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 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 site, which owns this collection of machines.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to list.
   */
  // const pageSize = 1234
  /**
   *  A page token received from previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Only resources matching this filter will be listed.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the order in which resources will be listed.
   */
  // const orderBy = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callListMachines();

listMachinesStream(request, options)

listMachinesStream(request?: protos.google.cloud.edgecontainer.v1.IListMachinesRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListMachinesRequest` 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 Machine 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 listMachinesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNodePools(request, options)

listNodePools(request?: protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.INodePool[],
        protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest | null,
        protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse
    ]>;

Lists NodePools in a given project and location.

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

Returns

Type Description

Promise<[
        protos.google.cloud.edgecontainer.v1.INodePool[],
        protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest | null,
        protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listNodePoolsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNodePools(request, options, callback)

listNodePools(request: protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse | null | undefined, protos.google.cloud.edgecontainer.v1.INodePool>): void;

Parameters
Name	Description
`request`	`IListNodePoolsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.INodePool>`

Returns
Type	Description
`void`

listNodePools(request, callback)

listNodePools(request: protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse | null | undefined, protos.google.cloud.edgecontainer.v1.INodePool>): void;

Parameters
Name	Description
`request`	`IListNodePoolsRequest`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, protos.google.cloud.edgecontainer.v1.IListNodePoolsResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.INodePool>`

Returns
Type	Description
`void`

listNodePoolsAsync(request, options)

listNodePoolsAsync(request?: protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgecontainer.v1.INodePool>;

Equivalent to listNodePools, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.edgecontainer.v1.INodePool>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 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 cluster, which owns this collection of node pools.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to list.
   */
  // const pageSize = 1234
  /**
   *  A page token received from previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Only resources matching this filter will be listed.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the order in which resources will be listed.
   */
  // const orderBy = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callListNodePools();

listNodePoolsStream(request, options)

listNodePoolsStream(request?: protos.google.cloud.edgecontainer.v1.IListNodePoolsRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListNodePoolsRequest` 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 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 `listNodePoolsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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)

listVpnConnections(request, options)

listVpnConnections(request?: protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgecontainer.v1.IVpnConnection[],
        protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest | null,
        protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse
    ]>;

Lists VPN connections in a given project and location.

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

Returns

Type Description

Promise<[
        protos.google.cloud.edgecontainer.v1.IVpnConnection[],
        protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest | null,
        protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listVpnConnectionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVpnConnections(request, options, callback)

listVpnConnections(request: protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse | null | undefined, protos.google.cloud.edgecontainer.v1.IVpnConnection>): void;

Parameters
Name	Description
`request`	`IListVpnConnectionsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.IVpnConnection>`

Returns
Type	Description
`void`

listVpnConnections(request, callback)

listVpnConnections(request: protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, callback: PaginationCallback<protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse | null | undefined, protos.google.cloud.edgecontainer.v1.IVpnConnection>): void;

Parameters
Name	Description
`request`	`IListVpnConnectionsRequest`
`callback`	`PaginationCallback<protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, protos.google.cloud.edgecontainer.v1.IListVpnConnectionsResponse \| null \| undefined, protos.google.cloud.edgecontainer.v1.IVpnConnection>`

Returns
Type	Description
`void`

listVpnConnectionsAsync(request, options)

listVpnConnectionsAsync(request?: protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgecontainer.v1.IVpnConnection>;

Equivalent to listVpnConnections, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.edgecontainer.v1.IVpnConnection>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 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 VPN
   *  connections.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to list.
   */
  // const pageSize = 1234
  /**
   *  A page token received from previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Only resources matching this filter will be listed.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the order in which resources will be listed.
   */
  // const orderBy = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callListVpnConnections();

listVpnConnectionsStream(request, options)

listVpnConnectionsStream(request?: protos.google.cloud.edgecontainer.v1.IListVpnConnectionsRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListVpnConnectionsRequest` 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 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 `listVpnConnectionsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation 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.

machinePath(project, location, machine)

machinePath(project: string, location: string, machine: string): string;

Return a fully-qualified machine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`machine`	`string`

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

matchClusterFromClusterName(clusterName)

matchClusterFromClusterName(clusterName: string): string | number;

Parse the cluster from Cluster resource.

Parameter
Name	Description
`clusterName`	`string` A fully-qualified path representing Cluster resource.

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

matchClusterFromNodePoolName(nodePoolName)

matchClusterFromNodePoolName(nodePoolName: string): string | number;

Parse the cluster from NodePool resource.

Parameter
Name	Description
`nodePoolName`	`string` A fully-qualified path representing NodePool resource.

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

matchLocationFromClusterName(clusterName)

matchLocationFromClusterName(clusterName: string): string | number;

Parse the location from Cluster resource.

Parameter
Name	Description
`clusterName`	`string` A fully-qualified path representing Cluster 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.

matchLocationFromMachineName(machineName)

matchLocationFromMachineName(machineName: string): string | number;

Parse the location from Machine resource.

Parameter
Name	Description
`machineName`	`string` A fully-qualified path representing Machine resource.

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

matchLocationFromNodePoolName(nodePoolName)

matchLocationFromNodePoolName(nodePoolName: string): string | number;

Parse the location from NodePool resource.

Parameter
Name	Description
`nodePoolName`	`string` A fully-qualified path representing NodePool resource.

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

matchLocationFromVpnConnectionName(vpnConnectionName)

matchLocationFromVpnConnectionName(vpnConnectionName: string): string | number;

Parse the location from VpnConnection resource.

Parameter
Name	Description
`vpnConnectionName`	`string` A fully-qualified path representing VpnConnection resource.

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

matchMachineFromMachineName(machineName)

matchMachineFromMachineName(machineName: string): string | number;

Parse the machine from Machine resource.

Parameter
Name	Description
`machineName`	`string` A fully-qualified path representing Machine resource.

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

matchNodePoolFromNodePoolName(nodePoolName)

matchNodePoolFromNodePoolName(nodePoolName: string): string | number;

Parse the node_pool from NodePool resource.

Parameter
Name	Description
`nodePoolName`	`string` A fully-qualified path representing NodePool resource.

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

matchProjectFromClusterName(clusterName)

matchProjectFromClusterName(clusterName: string): string | number;

Parse the project from Cluster resource.

Parameter
Name	Description
`clusterName`	`string` A fully-qualified path representing Cluster 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.

matchProjectFromMachineName(machineName)

matchProjectFromMachineName(machineName: string): string | number;

Parse the project from Machine resource.

Parameter
Name	Description
`machineName`	`string` A fully-qualified path representing Machine resource.

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

matchProjectFromNodePoolName(nodePoolName)

matchProjectFromNodePoolName(nodePoolName: string): string | number;

Parse the project from NodePool resource.

Parameter
Name	Description
`nodePoolName`	`string` A fully-qualified path representing NodePool 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.

matchProjectFromVpnConnectionName(vpnConnectionName)

matchProjectFromVpnConnectionName(vpnConnectionName: string): string | number;

Parse the project from VpnConnection resource.

Parameter
Name	Description
`vpnConnectionName`	`string` A fully-qualified path representing VpnConnection resource.

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

matchVpnConnectionFromVpnConnectionName(vpnConnectionName)

matchVpnConnectionFromVpnConnectionName(vpnConnectionName: string): string | number;

Parse the vpn_connection from VpnConnection resource.

Parameter
Name	Description
`vpnConnectionName`	`string` A fully-qualified path representing VpnConnection resource.

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

nodePoolPath(project, location, cluster, nodePool)

nodePoolPath(project: string, location: string, cluster: string, nodePool: string): string;

Return a fully-qualified nodePool resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`cluster`	`string`
`nodePool`	`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.

updateCluster(request, options)

updateCluster(request?: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Cluster.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.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 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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  Cluster resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  The updated cluster.
   */
  // const cluster = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters.
   *  A random UUID is recommended.
   *  This request is only idempotent if `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callUpdateCluster() {
    // Construct request
    const request = {
    };

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

  callUpdateCluster();

updateCluster(request, options, callback)

updateCluster(request: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateClusterRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateCluster(request, callback)

updateCluster(request: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateClusterRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateNodePool(request, options)

updateNodePool(request?: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single NodePool.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.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 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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  NodePool resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  The updated node pool.
   */
  // const nodePool = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

  async function callUpdateNodePool() {
    // Construct request
    const request = {
    };

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

  callUpdateNodePool();

updateNodePool(request, options, callback)

updateNodePool(request: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateNodePoolRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateNodePool(request, callback)

updateNodePool(request: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateNodePoolRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

upgradeCluster(request, options)

upgradeCluster(request?: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Upgrades a single cluster.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.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 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 of the cluster.
   */
  // const name = 'abc123'
  /**
   *  Required. The version the cluster is going to be upgraded to.
   */
  // const targetVersion = 'abc123'
  /**
   *  The schedule for the upgrade.
   */
  // const schedule = {}
  /**
   *  A unique identifier for this request. Restricted to 36 ASCII characters. A
   *  random UUID is recommended. This request is only idempotent if
   *  `request_id` is provided.
   */
  // const requestId = 'abc123'

  // Imports the Edgecontainer library
  const {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;

  // Instantiates a client
  const edgecontainerClient = new EdgeContainerClient();

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

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

  callUpgradeCluster();

upgradeCluster(request, options, callback)

upgradeCluster(request: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpgradeClusterRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

upgradeCluster(request, callback)

upgradeCluster(request: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpgradeClusterRequest`
`callback`	`Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

vpnConnectionPath(project, location, vpnConnection)

vpnConnectionPath(project: string, location: string, vpnConnection: string): string;

Return a fully-qualified vpnConnection resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`vpnConnection`	`string`

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