Class v1.VmwareEngineClient (0.1.2)

VMwareEngine manages VMware's private clusters in the Cloud. v1

Package

@google-cloud/vmwareengine

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of VmwareEngineClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.fallback

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

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

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.

vmwareEngineStub

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

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
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example 

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

checkCreateClusterProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to create a new cluster
   *  in. Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the new `Cluster`.
   *  This identifier must be unique among clusters within the parent and becomes
   *  the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The initial description of the new cluster.
   */
  // const cluster = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callCreateCluster();

checkCreateHcxActivationKeyProgress(name)

checkCreateHcxActivationKeyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.HcxActivationKey, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.HcxActivationKey, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to create the key for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  Required. The initial description of a new HCX activation key. When
   *  creating a new key, this field must be an empty object.
   */
  // const hcxActivationKey = {}
  /**
   *  Required. The user-provided identifier of the `HcxActivationKey` to be
   *  created. This identifier must be unique among `HcxActivationKey` resources
   *  within the parent and becomes the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const hcxActivationKeyId = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateHcxActivationKey() {
    // Construct request
    const request = {
      parent,
      hcxActivationKey,
      hcxActivationKeyId,
    };

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

  callCreateHcxActivationKey();

checkCreateNetworkPolicyProgress(name)

checkCreateNetworkPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location (region)
   *  to create the new network policy in.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *   `projects/my-project/locations/us-central1`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the network policy to be created.
   *  This identifier must be unique within parent
   *  `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes
   *  the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const networkPolicyId = 'abc123'
  /**
   *  Required. The network policy configuration to use in the request.
   */
  // const networkPolicy = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateNetworkPolicy() {
    // Construct request
    const request = {
      parent,
      networkPolicyId,
      networkPolicy,
    };

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

  callCreateNetworkPolicy();

checkCreatePrivateCloudProgress(name)

checkCreatePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to create the new
   *  private cloud in. Resource names are schemeless URIs that follow the
   *  conventions in https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the private cloud to be created.
   *  This identifier must be unique among each `PrivateCloud` within the parent
   *  and becomes the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const privateCloudId = 'abc123'
  /**
   *  Required. The initial description of the new private cloud.
   */
  // const privateCloud = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreatePrivateCloud() {
    // Construct request
    const request = {
      parent,
      privateCloudId,
      privateCloud,
    };

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

  callCreatePrivateCloud();

checkCreateVmwareEngineNetworkProgress(name)

checkCreateVmwareEngineNetworkProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to create the new VMware Engine
   *  network in. A VMware Engine network of type
   *  `LEGACY` is a regional resource, and a VMware
   *  Engine network of type `STANDARD` is a global resource.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names. For example:
   *  `projects/my-project/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the new VMware Engine network.
   *  This identifier must be unique among VMware Engine network resources
   *  within the parent and becomes the final token in the name URI. The
   *  identifier must meet the following requirements:
   *  * For networks of type LEGACY, adheres to the format:
   *  `{region-id}-default`. Replace `{region-id}` with the region where you want
   *  to create the VMware Engine network. For example, "us-central1-default".
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const vmwareEngineNetworkId = 'abc123'
  /**
   *  Required. The initial description of the new VMware Engine network.
   */
  // const vmwareEngineNetwork = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateVmwareEngineNetwork() {
    // Construct request
    const request = {
      parent,
      vmwareEngineNetworkId,
      vmwareEngineNetwork,
    };

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

  callCreateVmwareEngineNetwork();

checkDeleteClusterProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the cluster to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteCluster();

checkDeleteNetworkPolicyProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the network policy to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteNetworkPolicy();

checkDeletePrivateCloudProgress(name)

checkDeletePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, cascade delete is enabled and all children of
   *  this private cloud resource are also deleted. When this flag is set to
   *  false, the private cloud will not be deleted if there are any children
   *  other than the management cluster. The management cluster is always
   *  deleted.
   */
  // const force = true
  /**
   *  Optional. Time delay of the deletion specified in hours. The default value
   *  is `3`. Specifying a non-zero value for this field changes the value of
   *  `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned
   *  deletion time. Deletion can be cancelled before `expire_time` elapses using
   *  VmwareEngine.UndeletePrivateCloud google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud.
   *  Specifying a value of `0` for this field instead begins the deletion
   *  process and ceases billing immediately. During the final deletion process,
   *  the value of `PrivateCloud.state` becomes `PURGING`.
   */
  // const delayHours = 1234

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeletePrivateCloud();

checkDeleteVmwareEngineNetworkProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the VMware Engine network to be deleted.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/global/vmwareEngineNetworks/my-network`
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Checksum used to ensure that the user-provided value is up to
   *  date before the server processes the request. The server compares provided
   *  checksum with the current checksum of the resource. If the user-provided
   *  value is out of date, this request returns an `ABORTED` error.
   */
  // const etag = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteVmwareEngineNetwork();

checkResetNsxCredentialsProgress(name)

checkResetNsxCredentialsProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to reset credentials for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callResetNsxCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

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

  callResetNsxCredentials();

checkResetVcenterCredentialsProgress(name)

checkResetVcenterCredentialsProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to reset credentials for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callResetVcenterCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

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

  callResetVcenterCredentials();

checkUndeletePrivateCloudProgress(name)

checkUndeletePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud scheduled for deletion.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callUndeletePrivateCloud();

checkUpdateClusterProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `Cluster` resource by the update. The fields specified in the `updateMask`
   *  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 = {}
  /**
   *  Required. The description of the cluster.
   */
  // const cluster = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that
   *  zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callUpdateCluster();

checkUpdateNetworkPolicyProgress(name)

checkUpdateNetworkPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Network policy description.
   */
  // const networkPolicy = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `NetworkPolicy` 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 = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdateNetworkPolicy() {
    // Construct request
    const request = {
      networkPolicy,
      updateMask,
    };

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

  callUpdateNetworkPolicy();

checkUpdatePrivateCloudProgress(name)

checkUpdatePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Private cloud description.
   */
  // const privateCloud = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `PrivateCloud` resource by the update. The fields specified in `updateMask`
   *  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 = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdatePrivateCloud() {
    // Construct request
    const request = {
      privateCloud,
      updateMask,
    };

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

  callUpdatePrivateCloud();

checkUpdateVmwareEngineNetworkProgress(name)

checkUpdateVmwareEngineNetworkProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. VMware Engine network description.
   */
  // const vmwareEngineNetwork = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  VMware Engine network 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. Only the
   *  following fields can be updated: `description`.
   */
  // const updateMask = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdateVmwareEngineNetwork() {
    // Construct request
    const request = {
      vmwareEngineNetwork,
      updateMask,
    };

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

  callUpdateVmwareEngineNetwork();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

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

clusterPath(project, location, privateCloud, cluster)

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

Return a fully-qualified cluster resource name string.

Parameters
NameDescription
project string
location string
privateCloud string
cluster string
Returns
TypeDescription
string

{string} Resource name string.

createCluster(request, options)

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

Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient [node quota](https://cloud.google.com/vmware-engine/quotas).

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to create a new cluster
   *  in. Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the new `Cluster`.
   *  This identifier must be unique among clusters within the parent and becomes
   *  the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The initial description of the new cluster.
   */
  // const cluster = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callCreateCluster();

createCluster(request, options, callback)

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

createCluster(request, callback)

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

createHcxActivationKey(request, options)

createHcxActivationKey(request?: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new HCX activation key in a given private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to create the key for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  Required. The initial description of a new HCX activation key. When
   *  creating a new key, this field must be an empty object.
   */
  // const hcxActivationKey = {}
  /**
   *  Required. The user-provided identifier of the `HcxActivationKey` to be
   *  created. This identifier must be unique among `HcxActivationKey` resources
   *  within the parent and becomes the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const hcxActivationKeyId = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateHcxActivationKey() {
    // Construct request
    const request = {
      parent,
      hcxActivationKey,
      hcxActivationKeyId,
    };

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

  callCreateHcxActivationKey();

createHcxActivationKey(request, options, callback)

createHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createHcxActivationKey(request, callback)

createHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNetworkPolicy(request, options)

createNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location (region)
   *  to create the new network policy in.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *   `projects/my-project/locations/us-central1`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the network policy to be created.
   *  This identifier must be unique within parent
   *  `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes
   *  the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const networkPolicyId = 'abc123'
  /**
   *  Required. The network policy configuration to use in the request.
   */
  // const networkPolicy = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateNetworkPolicy() {
    // Construct request
    const request = {
      parent,
      networkPolicyId,
      networkPolicy,
    };

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

  callCreateNetworkPolicy();

createNetworkPolicy(request, options, callback)

createNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNetworkPolicy(request, callback)

createNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createPrivateCloud(request, options)

createPrivateCloud(request?: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new PrivateCloud resource in a given project and location. Private clouds can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a [management cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) for that private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to create the new
   *  private cloud in. Resource names are schemeless URIs that follow the
   *  conventions in https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the private cloud to be created.
   *  This identifier must be unique among each `PrivateCloud` within the parent
   *  and becomes the final token in the name URI.
   *  The identifier must meet the following requirements:
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const privateCloudId = 'abc123'
  /**
   *  Required. The initial description of the new private cloud.
   */
  // const privateCloud = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreatePrivateCloud() {
    // Construct request
    const request = {
      parent,
      privateCloudId,
      privateCloud,
    };

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

  callCreatePrivateCloud();

createPrivateCloud(request, options, callback)

createPrivateCloud(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createPrivateCloud(request, callback)

createPrivateCloud(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createVmwareEngineNetwork(request, options)

createVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new VMware Engine network that can be used by a private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to create the new VMware Engine
   *  network in. A VMware Engine network of type
   *  `LEGACY` is a regional resource, and a VMware
   *  Engine network of type `STANDARD` is a global resource.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names. For example:
   *  `projects/my-project/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Required. The user-provided identifier of the new VMware Engine network.
   *  This identifier must be unique among VMware Engine network resources
   *  within the parent and becomes the final token in the name URI. The
   *  identifier must meet the following requirements:
   *  * For networks of type LEGACY, adheres to the format:
   *  `{region-id}-default`. Replace `{region-id}` with the region where you want
   *  to create the VMware Engine network. For example, "us-central1-default".
   *  * Only contains 1-63 alphanumeric characters and hyphens
   *  * Begins with an alphabetical character
   *  * Ends with a non-hyphen character
   *  * Not formatted as a UUID
   *  * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
   *  (section 3.5)
   */
  // const vmwareEngineNetworkId = 'abc123'
  /**
   *  Required. The initial description of the new VMware Engine network.
   */
  // const vmwareEngineNetwork = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callCreateVmwareEngineNetwork() {
    // Construct request
    const request = {
      parent,
      vmwareEngineNetworkId,
      vmwareEngineNetwork,
    };

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

  callCreateVmwareEngineNetwork();

createVmwareEngineNetwork(request, options, callback)

createVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createVmwareEngineNetwork(request, callback)

createVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCluster(request, options)

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

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the cluster to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteCluster();

deleteCluster(request, options, callback)

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

deleteCluster(request, callback)

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

deleteNetworkPolicy(request, options)

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

Deletes a NetworkPolicy resource. A network policy cannot be deleted when NetworkService.state is set to RECONCILING for either its external IP or internet access service.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the network policy to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteNetworkPolicy();

deleteNetworkPolicy(request, options, callback)

deleteNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNetworkPolicy(request, callback)

deleteNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example 

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

deletePrivateCloud(request, options)

deletePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Schedules a PrivateCloud resource for deletion.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to delete.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, cascade delete is enabled and all children of
   *  this private cloud resource are also deleted. When this flag is set to
   *  false, the private cloud will not be deleted if there are any children
   *  other than the management cluster. The management cluster is always
   *  deleted.
   */
  // const force = true
  /**
   *  Optional. Time delay of the deletion specified in hours. The default value
   *  is `3`. Specifying a non-zero value for this field changes the value of
   *  `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned
   *  deletion time. Deletion can be cancelled before `expire_time` elapses using
   *  VmwareEngine.UndeletePrivateCloud google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud.
   *  Specifying a value of `0` for this field instead begins the deletion
   *  process and ceases billing immediately. During the final deletion process,
   *  the value of `PrivateCloud.state` becomes `PURGING`.
   */
  // const delayHours = 1234

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeletePrivateCloud();

deletePrivateCloud(request, options, callback)

deletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deletePrivateCloud(request, callback)

deletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteVmwareEngineNetwork(request, options)

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

Deletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the VMware Engine network to be deleted.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/global/vmwareEngineNetworks/my-network`
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Checksum used to ensure that the user-provided value is up to
   *  date before the server processes the request. The server compares provided
   *  checksum with the current checksum of the resource. If the user-provided
   *  value is out of date, this request returns an `ABORTED` error.
   */
  // const etag = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callDeleteVmwareEngineNetwork();

deleteVmwareEngineNetwork(request, options, callback)

deleteVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteVmwareEngineNetwork(request, callback)

deleteVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCluster(request, options)

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

Retrieves a Cluster resource by its resource name.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The cluster resource name to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callGetCluster();

getCluster(request, options, callback)

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

getCluster(request, callback)

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

getHcxActivationKey(request, options)

getHcxActivationKey(request?: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IHcxActivationKey,
        (protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | undefined),
        {} | undefined
    ]>;

Retrieves a HcxActivationKey resource by its resource name.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IHcxActivationKey, (protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | undefined), {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the HCX activation key to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

    // Run request
    const response = await vmwareengineClient.getHcxActivationKey(request);
    console.log(response);
  }

  callGetHcxActivationKey();

getHcxActivationKey(request, options, callback)

getHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getHcxActivationKey(request, callback)

getHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest
callback Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options, callback)

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

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

Parameters
NameDescription
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

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
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example 

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

getNetworkPolicy(request, options)

getNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.INetworkPolicy,
        protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | undefined,
        {} | undefined
    ]>;

Retrieves a NetworkPolicy resource by its resource name.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | undefined, {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the network policy to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

    // Run request
    const response = await vmwareengineClient.getNetworkPolicy(request);
    console.log(response);
  }

  callGetNetworkPolicy();

getNetworkPolicy(request, options, callback)

getNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNetworkPolicy(request, callback)

getNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest
callback Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNodeType(request, options)

getNodeType(request?: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.INodeType,
        protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single NodeType.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | undefined, {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the node type to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

    // Run request
    const response = await vmwareengineClient.getNodeType(request);
    console.log(response);
  }

  callGetNodeType();

getNodeType(request, options, callback)

getNodeType(request: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNodeType(request, callback)

getNodeType(request: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest
callback Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.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
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example 

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

getPrivateCloud(request, options)

getPrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IPrivateCloud,
        protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | undefined,
        {} | undefined
    ]>;

Retrieves a PrivateCloud resource by its resource name.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | undefined, {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

    // Run request
    const response = await vmwareengineClient.getPrivateCloud(request);
    console.log(response);
  }

  callGetPrivateCloud();

getPrivateCloud(request, options, callback)

getPrivateCloud(request: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getPrivateCloud(request, callback)

getPrivateCloud(request: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest
callback Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

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

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getVmwareEngineNetwork(request, options)

getVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork,
        (protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | undefined),
        {} | undefined
    ]>;

Retrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, (protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | undefined), {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the VMware Engine network to retrieve.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/global/vmwareEngineNetworks/my-network`
   */
  // const name = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

    // Run request
    const response = await vmwareengineClient.getVmwareEngineNetwork(request);
    console.log(response);
  }

  callGetVmwareEngineNetwork();

getVmwareEngineNetwork(request, options, callback)

getVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getVmwareEngineNetwork(request, callback)

getVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest
callback Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

hcxActivationKeyPath(project, location, privateCloud, hcxActivationKey)

hcxActivationKeyPath(project: string, location: string, privateCloud: string, hcxActivationKey: string): string;

Return a fully-qualified hcxActivationKey resource name string.

Parameters
NameDescription
project string
location string
privateCloud string
hcxActivationKey string
Returns
TypeDescription
string

{string} Resource name string.

initialize()

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

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

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

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

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

listClusters(request, options)

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

Lists Cluster resources in a given private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.ICluster[], protos.google.cloud.vmwareengine.v1.IListClustersRequest | null, protos.google.cloud.vmwareengine.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listClusters(request, options, callback)

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

listClusters(request, callback)

listClusters(request: protos.google.cloud.vmwareengine.v1.IListClustersRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListClustersRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>
Returns
TypeDescription
void

listClustersAsync(request, options)

listClustersAsync(request?: protos.google.cloud.vmwareengine.v1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.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
NameDescription
request protos.google.cloud.vmwareengine.v1.IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.ICluster>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to query for clusters.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of clusters to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListClusters` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListClusters`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  To filter on multiple expressions, provide each separate expression within
   *  parentheses. For example:
   *  

   *  (name = "example-cluster")
   *  (nodeCount = "3")
   *  


    

  • By default, each expression is an AND expression. However, you can
    • 

  • include AND and OR expressions explicitly. For example:
    • 

    • 

  • (name = "example-cluster-1") AND
    • 

  • (createTime > "2021-04-12T08:15:10.40Z") OR
    • 

  • (name = "example-cluster-2")
    • 

  • 
/
// const filter = 'abc123'
/*
    • 

  • Sorts list results by a certain order. By default, returned results are
    • 

  • ordered by name in ascending order. You can also sort results in
    • 

  • descending order based on the name value using orderBy="name desc".
    • 

  • Currently, only ordering by name is supported.
*/
// const orderBy = 'abc123'
    

    // Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
    

    // Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
    

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

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

    callListClusters();
    

    •

listClustersStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listHcxActivationKeys(request, options)

listHcxActivationKeys(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IHcxActivationKey[],
        protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest | null,
        protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse
    ]>;

Lists HcxActivationKey resources in a given private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IHcxActivationKey[], protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest | null, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse ]>

{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 listHcxActivationKeysAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listHcxActivationKeys(request, options, callback)

listHcxActivationKeys(request: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>
Returns
TypeDescription
void

listHcxActivationKeys(request, callback)

listHcxActivationKeys(request: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>
Returns
TypeDescription
void

listHcxActivationKeysAsync(request, options)

listHcxActivationKeysAsync(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IHcxActivationKey>;

Equivalent to listHcxActivationKeys, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.IHcxActivationKey>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to be queried for HCX activation keys.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of HCX activation keys to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListHcxActivationKeys` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListHcxActivationKeys` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callListHcxActivationKeys();

listHcxActivationKeysStream(request, options)

listHcxActivationKeysStream(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listHcxActivationKeysAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<LocationProtos.google.cloud.location.ILocation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

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

listNetworkPolicies(request, options)

listNetworkPolicies(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.INetworkPolicy[],
        protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest | null,
        protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse
    ]>;

Lists NetworkPolicy resources in a specified project and location.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.INetworkPolicy[], protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest | null, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse ]>

{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 listNetworkPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNetworkPolicies(request, options, callback)

listNetworkPolicies(request: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>
Returns
TypeDescription
void

listNetworkPolicies(request, callback)

listNetworkPolicies(request: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>
Returns
TypeDescription
void

listNetworkPoliciesAsync(request, options)

listNetworkPoliciesAsync(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPolicy>;

Equivalent to listNetworkPolicies, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPolicy>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location (region) to query for
   *  network policies. Resource names are schemeless URIs that follow the
   *  conventions in https://cloud.google.com/apis/design/resource_names. For
   *  example: `projects/my-project/locations/us-central1`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of network policies to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListNetworkPolicies` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListNetworkPolicies` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter expression that matches resources returned in the response.
   *  The expression must specify the field name, a comparison
   *  operator, and the value that you want to use for filtering. The value
   *  must be a string, a number, or a boolean. The comparison operator
   *  must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" network="" policies,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-policy`="" by="" specifying="" *="" `name="" !="example-policy" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">

   *  (name = "example-policy")
   *  (createTime > "2021-04-12T08:15:10.40Z")
   *  


    

  • By default, each expression is an AND expression. However, you
    • 

  • can include AND and OR expressions explicitly.
    • 

  • For example:
    • 

    • 

  • (name = "example-policy-1") AND
    • 

  • (createTime > "2021-04-12T08:15:10.40Z") OR
    • 

  • (name = "example-policy-2")
    • 

  • 
/
// const filter = 'abc123'
/*
    • 

  • Sorts list results by a certain order. By default, returned results
    • 

  • are ordered by name in ascending order.
    • 

  • You can also sort results in descending order based on the name value
    • 

  • using orderBy="name desc".
    • 

  • Currently, only ordering by name is supported.
*/
// const orderBy = 'abc123'
    

    // Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
    

    // Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
    

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

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

    callListNetworkPolicies();
    

    •

listNetworkPoliciesStream(request, options)

listNetworkPoliciesStream(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listNetworkPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNodeTypes(request, options)

listNodeTypes(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.INodeType[],
        protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest | null,
        protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse
    ]>;

Lists node types

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.INodeType[], protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest | null, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse ]>

{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 listNodeTypesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNodeTypes(request, options, callback)

listNodeTypes(request: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>
Returns
TypeDescription
void

listNodeTypes(request, callback)

listNodeTypes(request: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>
Returns
TypeDescription
void

listNodeTypesAsync(request, options)

listNodeTypesAsync(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INodeType>;

Equivalent to listNodeTypes, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.INodeType>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to be queried for node types.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of node types to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListNodeTypes` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListNodeTypes` must match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter expression that matches resources returned in the response.
   *  The expression must specify the field name, a comparison
   *  operator, and the value that you want to use for filtering. The value
   *  must be a string, a number, or a boolean. The comparison operator
   *  must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" node="" types,="" you="" can="" *="" exclude="" the="" ones="" named="" `standard-72`="" by="" specifying="" *="" `name="" !="standard-72" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">

   *  (name = "standard-72")
   *  (virtual_cpu_count > 2)
   *  


    

  • By default, each expression is an AND expression. However, you
    • 

  • can include AND and OR expressions explicitly.
    • 

  • For example:
    • 

    • 

  • (name = "standard-96") AND
    • 

  • (virtual_cpu_count > 2) OR
    • 

  • (name = "standard-72")
    • 

  • 
*/
// const filter = 'abc123'
    

    // Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
    

    // Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
    

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

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

    callListNodeTypes();
    

    •

listNodeTypesStream(request, options)

listNodeTypesStream(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listNodeTypesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.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
TypeDescription
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)

listPrivateClouds(request, options)

listPrivateClouds(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IPrivateCloud[],
        protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest | null,
        protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse
    ]>;

Lists PrivateCloud resources in a given project and location.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IPrivateCloud[], protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest | null, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse ]>

{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 listPrivateCloudsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listPrivateClouds(request, options, callback)

listPrivateClouds(request: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>
Returns
TypeDescription
void

listPrivateClouds(request, callback)

listPrivateClouds(request: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>
Returns
TypeDescription
void

listPrivateCloudsAsync(request, options)

listPrivateCloudsAsync(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateCloud>;

Equivalent to listPrivateClouds, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateCloud>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to be queried for
   *  clusters. Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of private clouds to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListPrivateClouds` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListPrivateClouds` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter expression that matches resources returned in the response.
   *  The expression must specify the field name, a comparison operator, and the
   *  value that you want to use for filtering. The value must be a string, a
   *  number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or
   *  `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" private="" clouds,="" you="" can="" exclude="" *="" the="" ones="" named="" `example-pc`="" by="" specifying="" `name="" !="example-pc" `.="" *="" you="" can="" also="" filter="" nested="" fields.="" for="" example,="" you="" could="" specify="" *="" `networkconfig.managementcidr="192.168.0.0/24" `="" to="" include="" private="" clouds="" *="" only="" if="" they="" have="" a="" matching="" address="" in="" their="" network="" configuration.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">

   *  (name = "example-pc")
   *  (createTime > "2021-04-12T08:15:10.40Z")
   *  


    

  • By default, each expression is an AND expression. However, you can
    • 

  • include AND and OR expressions explicitly. For example:
    • 

    • 

  • (name = "private-cloud-1") AND
    • 

  • (createTime > "2021-04-12T08:15:10.40Z") OR
    • 

  • (name = "private-cloud-2")
    • 

  • 
/
// const filter = 'abc123'
/*
    • 

  • Sorts list results by a certain order. By default, returned results are
    • 

  • ordered by name in ascending order. You can also sort results in
    • 

  • descending order based on the name value using orderBy="name desc".
    • 

  • Currently, only ordering by name is supported.
*/
// const orderBy = 'abc123'
    

    // Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
    

    // Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
    

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

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

    callListPrivateClouds();
    

    •

listPrivateCloudsStream(request, options)

listPrivateCloudsStream(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listPrivateCloudsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSubnets(request, options)

listSubnets(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.ISubnet[],
        protos.google.cloud.vmwareengine.v1.IListSubnetsRequest | null,
        protos.google.cloud.vmwareengine.v1.IListSubnetsResponse
    ]>;

Lists subnets in a given private cloud.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListSubnetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.ISubnet[], protos.google.cloud.vmwareengine.v1.IListSubnetsRequest | null, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse ]>

{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 listSubnetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSubnets(request, options, callback)

listSubnets(request: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListSubnetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>
Returns
TypeDescription
void

listSubnets(request, callback)

listSubnets(request: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListSubnetsRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>
Returns
TypeDescription
void

listSubnetsAsync(request, options)

listSubnetsAsync(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.ISubnet>;

Equivalent to listSubnets, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListSubnetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.ISubnet>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud to be queried for
   *  subnets.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of subnets to return in one page.
   *  The service may return fewer than this value.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListSubnetsRequest` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListSubnetsRequest` must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callListSubnets();

listSubnetsStream(request, options)

listSubnetsStream(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListSubnetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listSubnetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVmwareEngineNetworks(request, options)

listVmwareEngineNetworks(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork[],
        protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest | null,
        protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse
    ]>;

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork[], protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest | null, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse ]>

{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 listVmwareEngineNetworksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVmwareEngineNetworks(request, options, callback)

listVmwareEngineNetworks(request: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>
Returns
TypeDescription
void

listVmwareEngineNetworks(request, callback)

listVmwareEngineNetworks(request: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest
callback PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>
Returns
TypeDescription
void

listVmwareEngineNetworksAsync(request, options)

listVmwareEngineNetworksAsync(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>;

Equivalent to listVmwareEngineNetworks, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location to query for
   *  VMware Engine networks. Resource names are schemeless URIs that follow the
   *  conventions in https://cloud.google.com/apis/design/resource_names. For
   *  example: `projects/my-project/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in one page.
   *  The maximum value is coerced to 1000.
   *  The default value of this field is 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListVmwareEngineNetworks` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListVmwareEngineNetworks` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter expression that matches resources returned in the response.
   *  The expression must specify the field name, a comparison
   *  operator, and the value that you want to use for filtering. The value
   *  must be a string, a number, or a boolean. The comparison operator
   *  must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" network="" peerings,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-network`="" by="" specifying="" *="" `name="" !="example-network" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">

   *  (name = "example-network")
   *  (createTime > "2021-04-12T08:15:10.40Z")
   *  


    

  • By default, each expression is an AND expression. However, you
    • 

  • can include AND and OR expressions explicitly.
    • 

  • For example:
    • 

    • 

  • (name = "example-network-1") AND
    • 

  • (createTime > "2021-04-12T08:15:10.40Z") OR
    • 

  • (name = "example-network-2")
    • 

  • 
/
// const filter = 'abc123'
/*
    • 

  • Sorts list results by a certain order. By default, returned results
    • 

  • are ordered by name in ascending order.
    • 

  • You can also sort results in descending order based on the name value
    • 

  • using orderBy="name desc".
    • 

  • Currently, only ordering by name is supported.
*/
// const orderBy = 'abc123'
    

    // Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
    

    // Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
    

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

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

    callListVmwareEngineNetworks();
    

    •

listVmwareEngineNetworksStream(request, options)

listVmwareEngineNetworksStream(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing 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 listVmwareEngineNetworksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchClusterFromClusterName(clusterName)

matchClusterFromClusterName(clusterName: string): string | number;

Parse the cluster from Cluster resource.

Parameter
NameDescription
clusterName string

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the cluster.

matchHcxActivationKeyFromHcxActivationKeyName(hcxActivationKeyName)

matchHcxActivationKeyFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;

Parse the hcx_activation_key from HcxActivationKey resource.

Parameter
NameDescription
hcxActivationKeyName string

A fully-qualified path representing HcxActivationKey resource.

Returns
TypeDescription
string | number

{string} A string representing the hcx_activation_key.

matchLocationFromClusterName(clusterName)

matchLocationFromClusterName(clusterName: string): string | number;

Parse the location from Cluster resource.

Parameter
NameDescription
clusterName string

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromHcxActivationKeyName(hcxActivationKeyName)

matchLocationFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;

Parse the location from HcxActivationKey resource.

Parameter
NameDescription
hcxActivationKeyName string

A fully-qualified path representing HcxActivationKey resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromNetworkPolicyName(networkPolicyName)

matchLocationFromNetworkPolicyName(networkPolicyName: string): string | number;

Parse the location from NetworkPolicy resource.

Parameter
NameDescription
networkPolicyName string

A fully-qualified path representing NetworkPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromNodeTypeName(nodeTypeName)

matchLocationFromNodeTypeName(nodeTypeName: string): string | number;

Parse the location from NodeType resource.

Parameter
NameDescription
nodeTypeName string

A fully-qualified path representing NodeType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPrivateCloudName(privateCloudName)

matchLocationFromPrivateCloudName(privateCloudName: string): string | number;

Parse the location from PrivateCloud resource.

Parameter
NameDescription
privateCloudName string

A fully-qualified path representing PrivateCloud resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSubnetName(subnetName)

matchLocationFromSubnetName(subnetName: string): string | number;

Parse the location from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromVmwareEngineNetworkName(vmwareEngineNetworkName)

matchLocationFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;

Parse the location from VmwareEngineNetwork resource.

Parameter
NameDescription
vmwareEngineNetworkName string

A fully-qualified path representing VmwareEngineNetwork resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchNetworkPolicyFromNetworkPolicyName(networkPolicyName)

matchNetworkPolicyFromNetworkPolicyName(networkPolicyName: string): string | number;

Parse the network_policy from NetworkPolicy resource.

Parameter
NameDescription
networkPolicyName string

A fully-qualified path representing NetworkPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the network_policy.

matchNodeTypeFromNodeTypeName(nodeTypeName)

matchNodeTypeFromNodeTypeName(nodeTypeName: string): string | number;

Parse the node_type from NodeType resource.

Parameter
NameDescription
nodeTypeName string

A fully-qualified path representing NodeType resource.

Returns
TypeDescription
string | number

{string} A string representing the node_type.

matchPrivateCloudFromClusterName(clusterName)

matchPrivateCloudFromClusterName(clusterName: string): string | number;

Parse the private_cloud from Cluster resource.

Parameter
NameDescription
clusterName string

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the private_cloud.

matchPrivateCloudFromHcxActivationKeyName(hcxActivationKeyName)

matchPrivateCloudFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;

Parse the private_cloud from HcxActivationKey resource.

Parameter
NameDescription
hcxActivationKeyName string

A fully-qualified path representing HcxActivationKey resource.

Returns
TypeDescription
string | number

{string} A string representing the private_cloud.

matchPrivateCloudFromPrivateCloudName(privateCloudName)

matchPrivateCloudFromPrivateCloudName(privateCloudName: string): string | number;

Parse the private_cloud from PrivateCloud resource.

Parameter
NameDescription
privateCloudName string

A fully-qualified path representing PrivateCloud resource.

Returns
TypeDescription
string | number

{string} A string representing the private_cloud.

matchPrivateCloudFromSubnetName(subnetName)

matchPrivateCloudFromSubnetName(subnetName: string): string | number;

Parse the private_cloud from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the private_cloud.

matchProjectFromClusterName(clusterName)

matchProjectFromClusterName(clusterName: string): string | number;

Parse the project from Cluster resource.

Parameter
NameDescription
clusterName string

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromHcxActivationKeyName(hcxActivationKeyName)

matchProjectFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;

Parse the project from HcxActivationKey resource.

Parameter
NameDescription
hcxActivationKeyName string

A fully-qualified path representing HcxActivationKey resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromNetworkPolicyName(networkPolicyName)

matchProjectFromNetworkPolicyName(networkPolicyName: string): string | number;

Parse the project from NetworkPolicy resource.

Parameter
NameDescription
networkPolicyName string

A fully-qualified path representing NetworkPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromNodeTypeName(nodeTypeName)

matchProjectFromNodeTypeName(nodeTypeName: string): string | number;

Parse the project from NodeType resource.

Parameter
NameDescription
nodeTypeName string

A fully-qualified path representing NodeType resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromPrivateCloudName(privateCloudName)

matchProjectFromPrivateCloudName(privateCloudName: string): string | number;

Parse the project from PrivateCloud resource.

Parameter
NameDescription
privateCloudName string

A fully-qualified path representing PrivateCloud resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSubnetName(subnetName)

matchProjectFromSubnetName(subnetName: string): string | number;

Parse the project from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromVmwareEngineNetworkName(vmwareEngineNetworkName)

matchProjectFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;

Parse the project from VmwareEngineNetwork resource.

Parameter
NameDescription
vmwareEngineNetworkName string

A fully-qualified path representing VmwareEngineNetwork resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchSubnetFromSubnetName(subnetName)

matchSubnetFromSubnetName(subnetName: string): string | number;

Parse the subnet from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the subnet.

matchVmwareEngineNetworkFromVmwareEngineNetworkName(vmwareEngineNetworkName)

matchVmwareEngineNetworkFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;

Parse the vmware_engine_network from VmwareEngineNetwork resource.

Parameter
NameDescription
vmwareEngineNetworkName string

A fully-qualified path representing VmwareEngineNetwork resource.

Returns
TypeDescription
string | number

{string} A string representing the vmware_engine_network.

networkPolicyPath(project, location, networkPolicy)

networkPolicyPath(project: string, location: string, networkPolicy: string): string;

Return a fully-qualified networkPolicy resource name string.

Parameters
NameDescription
project string
location string
networkPolicy string
Returns
TypeDescription
string

{string} Resource name string.

nodeTypePath(project, location, nodeType)

nodeTypePath(project: string, location: string, nodeType: string): string;

Return a fully-qualified nodeType resource name string.

Parameters
NameDescription
project string
location string
nodeType string
Returns
TypeDescription
string

{string} Resource name string.

privateCloudPath(project, location, privateCloud)

privateCloudPath(project: string, location: string, privateCloud: string): string;

Return a fully-qualified privateCloud resource name string.

Parameters
NameDescription
project string
location string
privateCloud string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

resetNsxCredentials(request, options)

resetNsxCredentials(request?: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Resets credentials of the NSX appliance.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to reset credentials for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callResetNsxCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

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

  callResetNsxCredentials();

resetNsxCredentials(request, options, callback)

resetNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resetNsxCredentials(request, callback)

resetNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resetVcenterCredentials(request, options)

resetVcenterCredentials(request?: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Resets credentials of the Vcenter appliance.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to reset credentials for.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callResetVcenterCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

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

  callResetVcenterCredentials();

resetVcenterCredentials(request, options, callback)

resetVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resetVcenterCredentials(request, callback)

resetVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, options, callback)

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

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

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

Parameters
NameDescription
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

showNsxCredentials(request, options)

showNsxCredentials(request?: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.ICredentials,
        (protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | undefined),
        {} | undefined
    ]>;

Gets details of credentials for NSX appliance.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.ICredentials, (protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | undefined), {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to be queried for credentials.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callShowNsxCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

    // Run request
    const response = await vmwareengineClient.showNsxCredentials(request);
    console.log(response);
  }

  callShowNsxCredentials();

showNsxCredentials(request, options, callback)

showNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

showNsxCredentials(request, callback)

showNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest
callback Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

showVcenterCredentials(request, options)

showVcenterCredentials(request?: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.vmwareengine.v1.ICredentials,
        (protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | undefined),
        {} | undefined
    ]>;

Gets details of credentials for Vcenter appliance.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.vmwareengine.v1.ICredentials, (protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | undefined), {} | undefined ]>

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

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud
   *  to be queried for credentials.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const privateCloud = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callShowVcenterCredentials() {
    // Construct request
    const request = {
      privateCloud,
    };

    // Run request
    const response = await vmwareengineClient.showVcenterCredentials(request);
    console.log(response);
  }

  callShowVcenterCredentials();

showVcenterCredentials(request, options, callback)

showVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest
options CallOptions
callback Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

showVcenterCredentials(request, callback)

showVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest
callback Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

subnetPath(project, location, privateCloud, subnet)

subnetPath(project: string, location: string, privateCloud: string, subnet: string): string;

Return a fully-qualified subnet resource name string.

Parameters
NameDescription
project string
location string
privateCloud string
subnet string
Returns
TypeDescription
string

{string} Resource name string.

testIamPermissions(request, options, callback)

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

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

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

Parameters
NameDescription
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

undeletePrivateCloud(request, options)

undeletePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the private cloud scheduled for deletion.
   *  Resource names are schemeless URIs that follow the conventions in
   *  https://cloud.google.com/apis/design/resource_names.
   *  For example:
   *  `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
   */
  // const name = 'abc123'
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callUndeletePrivateCloud();

undeletePrivateCloud(request, options, callback)

undeletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

undeletePrivateCloud(request, callback)

undeletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCluster(request, options)

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

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `Cluster` resource by the update. The fields specified in the `updateMask`
   *  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 = {}
  /**
   *  Required. The description of the cluster.
   */
  // const cluster = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that
   *  zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. True if you want the request to be validated and not executed;
   *  false otherwise.
   */
  // const validateOnly = true

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

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

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

  callUpdateCluster();

updateCluster(request, options, callback)

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

updateCluster(request, callback)

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

updateNetworkPolicy(request, options)

updateNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Modifies a NetworkPolicy resource. Only the following fields can be updated: internet_access, external_ip, edge_services_cidr. Only fields specified in updateMask are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService cannot be updated when NetworkService.state is set to RECONCILING.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Network policy description.
   */
  // const networkPolicy = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `NetworkPolicy` 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 = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdateNetworkPolicy() {
    // Construct request
    const request = {
      networkPolicy,
      updateMask,
    };

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

  callUpdateNetworkPolicy();

updateNetworkPolicy(request, options, callback)

updateNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateNetworkPolicy(request, callback)

updateNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updatePrivateCloud(request, options)

updatePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Modifies a PrivateCloud resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Private cloud description.
   */
  // const privateCloud = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  `PrivateCloud` resource by the update. The fields specified in `updateMask`
   *  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 = {}
  /**
   *  Optional. The request ID must be a valid UUID with the exception that zero
   *  UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdatePrivateCloud() {
    // Construct request
    const request = {
      privateCloud,
      updateMask,
    };

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

  callUpdatePrivateCloud();

updatePrivateCloud(request, options, callback)

updatePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updatePrivateCloud(request, callback)

updatePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateVmwareEngineNetwork(request, options)

updateVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. VMware Engine network description.
   */
  // const vmwareEngineNetwork = {}
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  VMware Engine network 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. Only the
   *  following fields can be updated: `description`.
   */
  // const updateMask = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server guarantees that a
   *  request doesn't result in creation of duplicate commitments for at least 60
   *  minutes.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Vmwareengine library
  const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

  // Instantiates a client
  const vmwareengineClient = new VmwareEngineClient();

  async function callUpdateVmwareEngineNetwork() {
    // Construct request
    const request = {
      vmwareEngineNetwork,
      updateMask,
    };

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

  callUpdateVmwareEngineNetwork();

updateVmwareEngineNetwork(request, options, callback)

updateVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateVmwareEngineNetwork(request, callback)

updateVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest
callback Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

vmwareEngineNetworkPath(project, location, vmwareEngineNetwork)

vmwareEngineNetworkPath(project: string, location: string, vmwareEngineNetwork: string): string;

Return a fully-qualified vmwareEngineNetwork resource name string.

Parameters
NameDescription
project string
location string
vmwareEngineNetwork string
Returns
TypeDescription
string

{string} Resource name string.