Class v1.NetAppClient (0.8.0)

NetApp Files Google Cloud Service v1

Package

@google-cloud/netapp

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of NetAppClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

netAppStub

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

activeDirectoryPath(project, location, activeDirectory)

activeDirectoryPath(project: string, location: string, activeDirectory: string): string;

Return a fully-qualified activeDirectory resource name string.

Parameters
Name Description
project string
location string
activeDirectory string
Returns
Type Description
string

{string} Resource name string.

backupPath(project, location, backupVault, backup)

backupPath(project: string, location: string, backupVault: string, backup: string): string;

Return a fully-qualified backup resource name string.

Parameters
Name Description
project string
location string
backupVault string
backup string
Returns
Type Description
string

{string} Resource name string.

backupPolicyPath(project, location, backupPolicy)

backupPolicyPath(project: string, location: string, backupPolicy: string): string;

Return a fully-qualified backupPolicy resource name string.

Parameters
Name Description
project string
location string
backupPolicy string
Returns
Type Description
string

{string} Resource name string.

backupVaultPath(project, location, backupVault)

backupVaultPath(project: string, location: string, backupVault: string): string;

Return a fully-qualified backupVault resource name string.

Parameters
Name Description
project string
location string
backupVault string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, options, callback)

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

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

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

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

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

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

checkCreateActiveDirectoryProgress(name)

checkCreateActiveDirectoryProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.ActiveDirectory, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.ActiveDirectory, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Fields of the to be created active directory.
   */
  // const activeDirectory = {}
  /**
   *  Required. ID of the active directory to create. Must be unique within the
   *  parent resource. Must contain only letters, numbers and hyphen, with the
   *  first character a letter , the last a letter or a number, and a 63
   *  character maximum.
   */
  // const activeDirectoryId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateActiveDirectory() {
    // Construct request
    const request = {
      parent,
      activeDirectory,
      activeDirectoryId,
    };

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

  callCreateActiveDirectory();

checkCreateBackupPolicyProgress(name)

checkCreateBackupPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.BackupPolicy, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.BackupPolicy, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create the backup policies of, in the format
   *  `projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A backupPolicy resource
   */
  // const backupPolicy = {}
  /**
   *  Required. The ID to use for the backup policy.
   *  The ID must be unique within the specified location.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupPolicyId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackupPolicy() {
    // Construct request
    const request = {
      parent,
      backupPolicy,
      backupPolicyId,
    };

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

  callCreateBackupPolicy();

checkCreateBackupProgress(name)

checkCreateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Backup, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Backup, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp backupVault to create the backups of, in the format
   *  `projects/* /locations/* /backupVaults/{backup_vault_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the backup.
   *  The ID must be unique within the specified backupVault.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupId = 'abc123'
  /**
   *  Required. A backup resource
   */
  // const backup = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackup() {
    // Construct request
    const request = {
      parent,
      backupId,
      backup,
    };

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

  callCreateBackup();

checkCreateBackupVaultProgress(name)

checkCreateBackupVaultProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.BackupVault, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.BackupVault, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create the backup vaults, in the format
   *  `projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the backupVault.
   *  The ID must be unique within the specified location.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupVaultId = 'abc123'
  /**
   *  Required. A backupVault resource
   */
  // const backupVault = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackupVault() {
    // Construct request
    const request = {
      parent,
      backupVaultId,
      backupVault,
    };

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

  callCreateBackupVault();

checkCreateKmsConfigProgress(name)

checkCreateKmsConfigProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting KmsConfig. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const kmsConfigId = 'abc123'
  /**
   *  Required. The required parameters to create a new KmsConfig.
   */
  // const kmsConfig = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateKmsConfig() {
    // Construct request
    const request = {
      parent,
      kmsConfigId,
      kmsConfig,
    };

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

  callCreateKmsConfig();

checkCreateReplicationProgress(name)

checkCreateReplicationProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp volume to create the replications of, in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A replication resource
   */
  // const replication = {}
  /**
   *  Required. ID of the replication to create. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const replicationId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateReplication() {
    // Construct request
    const request = {
      parent,
      replication,
      replicationId,
    };

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

  callCreateReplication();

checkCreateSnapshotProgress(name)

checkCreateSnapshotProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Snapshot, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Snapshot, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp volume to create the snapshots of, in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A snapshot resource
   */
  // const snapshot = {}
  /**
   *  Required. ID of the snapshot to create. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const snapshotId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateSnapshot() {
    // Construct request
    const request = {
      parent,
      snapshot,
      snapshotId,
    };

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

  callCreateSnapshot();

checkCreateStoragePoolProgress(name)

checkCreateStoragePoolProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting storage pool. Must be unique within the
   *  parent resource. Must contain only letters, numbers and hyphen, with the
   *  first character a letter, the last a letter or a number, and a 63 character
   *  maximum.
   */
  // const storagePoolId = 'abc123'
  /**
   *  Required. The required parameters to create a new storage pool.
   */
  // const storagePool = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateStoragePool() {
    // Construct request
    const request = {
      parent,
      storagePoolId,
      storagePool,
    };

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

  callCreateStoragePool();

checkCreateVolumeProgress(name)

checkCreateVolumeProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting volume. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a number,
   *  and a 63 character maximum.
   */
  // const volumeId = 'abc123'
  /**
   *  Required. The volume being created.
   */
  // const volume = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateVolume() {
    // Construct request
    const request = {
      parent,
      volumeId,
      volume,
    };

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

  callCreateVolume();

checkDeleteActiveDirectoryProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the active directory.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteActiveDirectory();

checkDeleteBackupPolicyProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The backup policy resource name, in the format
   *  `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteBackupPolicy();

checkDeleteBackupProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The backup resource name, in the format
   *  `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteBackup();

checkDeleteBackupVaultProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The backupVault resource name, in the format
   *  `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteBackupVault();

checkDeleteKmsConfigProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the KmsConfig.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteKmsConfig();

checkDeleteReplicationProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The replication resource name, in the format
   *  `projects/* /locations/* /volumes/* /replications/{replication_id}`
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteReplication();

checkDeleteSnapshotProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The snapshot resource name, in the format
   *  `projects/* /locations/* /volumes/* /snapshots/{snapshot_id}`
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteSnapshot();

checkDeleteStoragePoolProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the storage pool
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteStoragePool();

checkDeleteVolumeProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the volume
   */
  // const name = 'abc123'
  /**
   *  If this field is set as true, CCFE will not block the volume resource
   *  deletion even if it has any snapshots resource. (Otherwise, the request
   *  will only work if the volume has no snapshots.)
   */
  // const force = true

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callDeleteVolume();

checkEncryptVolumesProgress(name)

checkEncryptVolumesProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the KmsConfig.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callEncryptVolumes();

checkEstablishPeeringProgress(name)

checkEstablishPeeringProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the replication, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
   */
  // const name = 'abc123'
  /**
   *  Required. Name of the user's local source cluster to be peered with the
   *  destination cluster.
   */
  // const peerClusterName = 'abc123'
  /**
   *  Required. Name of the user's local source vserver svm to be peered with the
   *  destination vserver svm.
   */
  // const peerSvmName = 'abc123'
  /**
   *  Optional. List of IPv4 ip addresses to be used for peering.
   */
  // const peerIpAddresses = ['abc','def']
  /**
   *  Required. Name of the user's local source volume to be peered with the
   *  destination volume.
   */
  // const peerVolumeName = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callEstablishPeering() {
    // Construct request
    const request = {
      name,
      peerClusterName,
      peerSvmName,
      peerVolumeName,
    };

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

  callEstablishPeering();

checkResumeReplicationProgress(name)

checkResumeReplicationProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the replication, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callResumeReplication();

checkReverseReplicationDirectionProgress(name)

checkReverseReplicationDirectionProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the replication, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callReverseReplicationDirection();

checkRevertVolumeProgress(name)

checkRevertVolumeProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the volume, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}.
   */
  // const name = 'abc123'
  /**
   *  Required. The snapshot resource ID, in the format 'my-snapshot', where the
   *  specified ID is the {snapshot_id} of the fully qualified name like
   *  projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}
   */
  // const snapshotId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callRevertVolume();

checkStopReplicationProgress(name)

checkStopReplicationProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the replication, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
   */
  // const name = 'abc123'
  /**
   *  Indicates whether to stop replication forcefully while data transfer is in
   *  progress.
   *  Warning! if force is true, this will abort any current transfers
   *  and can lead to data loss due to partial transfer.
   *  If force is false, stop replication will fail while data transfer is in
   *  progress and you will need to retry later.
   */
  // const force = true

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callStopReplication();

checkSwitchActiveReplicaZoneProgress(name)

checkSwitchActiveReplicaZoneProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the storage pool
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callSwitchActiveReplicaZone();

checkSyncReplicationProgress(name)

checkSyncReplicationProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the replication, in the format of
   *  projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callSyncReplication();

checkUpdateActiveDirectoryProgress(name)

checkUpdateActiveDirectoryProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.ActiveDirectory, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.ActiveDirectory, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Active Directory 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 = {}
  /**
   *  Required. The volume being updated
   */
  // const activeDirectory = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateActiveDirectory() {
    // Construct request
    const request = {
      updateMask,
      activeDirectory,
    };

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

  callUpdateActiveDirectory();

checkUpdateBackupPolicyProgress(name)

checkUpdateBackupPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.BackupPolicy, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.BackupPolicy, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Backup Policy 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 = {}
  /**
   *  Required. The backup policy being updated
   */
  // const backupPolicy = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateBackupPolicy() {
    // Construct request
    const request = {
      updateMask,
      backupPolicy,
    };

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

  callUpdateBackupPolicy();

checkUpdateBackupProgress(name)

checkUpdateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Backup, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Backup, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Backup resource to be updated.
   *  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 = {}
  /**
   *  Required. The backup being updated
   */
  // const backup = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateBackup() {
    // Construct request
    const request = {
      updateMask,
      backup,
    };

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

  callUpdateBackup();

checkUpdateBackupVaultProgress(name)

checkUpdateBackupVaultProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.BackupVault, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.BackupVault, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Backup resource to be updated.
   *  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 = {}
  /**
   *  Required. The backupVault being updated
   */
  // const backupVault = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateBackupVault() {
    // Construct request
    const request = {
      updateMask,
      backupVault,
    };

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

  callUpdateBackupVault();

checkUpdateKmsConfigProgress(name)

checkUpdateKmsConfigProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.KmsConfig, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  KmsConfig 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 = {}
  /**
   *  Required. The KmsConfig being updated
   */
  // const kmsConfig = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateKmsConfig() {
    // Construct request
    const request = {
      updateMask,
      kmsConfig,
    };

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

  callUpdateKmsConfig();

checkUpdateReplicationProgress(name)

checkUpdateReplicationProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Replication, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.  At least one path must be supplied in
   *  this field.
   */
  // const updateMask = {}
  /**
   *  Required. A replication resource
   */
  // const replication = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateReplication() {
    // Construct request
    const request = {
      updateMask,
      replication,
    };

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

  callUpdateReplication();

checkUpdateSnapshotProgress(name)

checkUpdateSnapshotProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Snapshot, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Snapshot, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Mask of fields to update.  At least one path must be supplied in
   *  this field.
   */
  // const updateMask = {}
  /**
   *  Required. A snapshot resource
   */
  // const snapshot = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateSnapshot() {
    // Construct request
    const request = {
      updateMask,
      snapshot,
    };

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

  callUpdateSnapshot();

checkUpdateStoragePoolProgress(name)

checkUpdateStoragePoolProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.StoragePool, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  StoragePool 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 = {}
  /**
   *  Required. The pool being updated
   */
  // const storagePool = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateStoragePool() {
    // Construct request
    const request = {
      updateMask,
      storagePool,
    };

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

  callUpdateStoragePool();

checkUpdateVolumeProgress(name)

checkUpdateVolumeProgress(name: string): Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.netapp.v1.Volume, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Volume 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 = {}
  /**
   *  Required. The volume being updated
   */
  // const volume = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callUpdateVolume() {
    // Construct request
    const request = {
      updateMask,
      volume,
    };

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

  callUpdateVolume();

checkValidateDirectoryServiceProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.netapp.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the storage pool
   */
  // const name = 'abc123'
  /**
   *  Type of directory service policy attached to the storage pool.
   */
  // const directoryServiceType = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

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

  callValidateDirectoryService();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
Type Description
Promise<void>

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

createActiveDirectory(request, options)

createActiveDirectory(request?: protos.google.cloud.netapp.v1.ICreateActiveDirectoryRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

CreateActiveDirectory Creates the active directory specified in the request.

Parameters
Name Description
request ICreateActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Fields of the to be created active directory.
   */
  // const activeDirectory = {}
  /**
   *  Required. ID of the active directory to create. Must be unique within the
   *  parent resource. Must contain only letters, numbers and hyphen, with the
   *  first character a letter , the last a letter or a number, and a 63
   *  character maximum.
   */
  // const activeDirectoryId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateActiveDirectory() {
    // Construct request
    const request = {
      parent,
      activeDirectory,
      activeDirectoryId,
    };

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

  callCreateActiveDirectory();

createActiveDirectory(request, options, callback)

createActiveDirectory(request: protos.google.cloud.netapp.v1.ICreateActiveDirectoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateActiveDirectoryRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createActiveDirectory(request, callback)

createActiveDirectory(request: protos.google.cloud.netapp.v1.ICreateActiveDirectoryRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateActiveDirectoryRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackup(request, options)

createBackup(request?: protos.google.cloud.netapp.v1.ICreateBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

Parameters
Name Description
request ICreateBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp backupVault to create the backups of, in the format
   *  `projects/* /locations/* /backupVaults/{backup_vault_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the backup.
   *  The ID must be unique within the specified backupVault.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupId = 'abc123'
  /**
   *  Required. A backup resource
   */
  // const backup = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackup() {
    // Construct request
    const request = {
      parent,
      backupId,
      backup,
    };

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

  callCreateBackup();

createBackup(request, options, callback)

createBackup(request: protos.google.cloud.netapp.v1.ICreateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackup(request, callback)

createBackup(request: protos.google.cloud.netapp.v1.ICreateBackupRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackupPolicy(request, options)

createBackupPolicy(request?: protos.google.cloud.netapp.v1.ICreateBackupPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates new backup policy

Parameters
Name Description
request ICreateBackupPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create the backup policies of, in the format
   *  `projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A backupPolicy resource
   */
  // const backupPolicy = {}
  /**
   *  Required. The ID to use for the backup policy.
   *  The ID must be unique within the specified location.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupPolicyId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackupPolicy() {
    // Construct request
    const request = {
      parent,
      backupPolicy,
      backupPolicyId,
    };

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

  callCreateBackupPolicy();

createBackupPolicy(request, options, callback)

createBackupPolicy(request: protos.google.cloud.netapp.v1.ICreateBackupPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupPolicyRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackupPolicy(request, callback)

createBackupPolicy(request: protos.google.cloud.netapp.v1.ICreateBackupPolicyRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupPolicyRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackupVault(request, options)

createBackupVault(request?: protos.google.cloud.netapp.v1.ICreateBackupVaultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates new backup vault

Parameters
Name Description
request ICreateBackupVaultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create the backup vaults, in the format
   *  `projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the backupVault.
   *  The ID must be unique within the specified location.
   *  Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const backupVaultId = 'abc123'
  /**
   *  Required. A backupVault resource
   */
  // const backupVault = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateBackupVault() {
    // Construct request
    const request = {
      parent,
      backupVaultId,
      backupVault,
    };

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

  callCreateBackupVault();

createBackupVault(request, options, callback)

createBackupVault(request: protos.google.cloud.netapp.v1.ICreateBackupVaultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupVaultRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackupVault(request, callback)

createBackupVault(request: protos.google.cloud.netapp.v1.ICreateBackupVaultRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBackupVaultRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createKmsConfig(request, options)

createKmsConfig(request?: protos.google.cloud.netapp.v1.ICreateKmsConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new KMS config.

Parameters
Name Description
request ICreateKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting KmsConfig. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const kmsConfigId = 'abc123'
  /**
   *  Required. The required parameters to create a new KmsConfig.
   */
  // const kmsConfig = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateKmsConfig() {
    // Construct request
    const request = {
      parent,
      kmsConfigId,
      kmsConfig,
    };

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

  callCreateKmsConfig();

createKmsConfig(request, options, callback)

createKmsConfig(request: protos.google.cloud.netapp.v1.ICreateKmsConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateKmsConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createKmsConfig(request, callback)

createKmsConfig(request: protos.google.cloud.netapp.v1.ICreateKmsConfigRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateKmsConfigRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createReplication(request, options)

createReplication(request?: protos.google.cloud.netapp.v1.ICreateReplicationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a new replication for a volume.

Parameters
Name Description
request ICreateReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp volume to create the replications of, in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A replication resource
   */
  // const replication = {}
  /**
   *  Required. ID of the replication to create. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const replicationId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateReplication() {
    // Construct request
    const request = {
      parent,
      replication,
      replicationId,
    };

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

  callCreateReplication();

createReplication(request, options, callback)

createReplication(request: protos.google.cloud.netapp.v1.ICreateReplicationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateReplicationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createReplication(request, callback)

createReplication(request: protos.google.cloud.netapp.v1.ICreateReplicationRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateReplicationRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createSnapshot(request, options)

createSnapshot(request?: protos.google.cloud.netapp.v1.ICreateSnapshotRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a new snapshot for a volume.

Parameters
Name Description
request ICreateSnapshotRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The NetApp volume to create the snapshots of, in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A snapshot resource
   */
  // const snapshot = {}
  /**
   *  Required. ID of the snapshot to create. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a
   *  number, and a 63 character maximum.
   */
  // const snapshotId = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateSnapshot() {
    // Construct request
    const request = {
      parent,
      snapshot,
      snapshotId,
    };

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

  callCreateSnapshot();

createSnapshot(request, options, callback)

createSnapshot(request: protos.google.cloud.netapp.v1.ICreateSnapshotRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSnapshotRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createSnapshot(request, callback)

createSnapshot(request: protos.google.cloud.netapp.v1.ICreateSnapshotRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSnapshotRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createStoragePool(request, options)

createStoragePool(request?: protos.google.cloud.netapp.v1.ICreateStoragePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new storage pool.

Parameters
Name Description
request ICreateStoragePoolRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting storage pool. Must be unique within the
   *  parent resource. Must contain only letters, numbers and hyphen, with the
   *  first character a letter, the last a letter or a number, and a 63 character
   *  maximum.
   */
  // const storagePoolId = 'abc123'
  /**
   *  Required. The required parameters to create a new storage pool.
   */
  // const storagePool = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateStoragePool() {
    // Construct request
    const request = {
      parent,
      storagePoolId,
      storagePool,
    };

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

  callCreateStoragePool();

createStoragePool(request, options, callback)

createStoragePool(request: protos.google.cloud.netapp.v1.ICreateStoragePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateStoragePoolRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createStoragePool(request, callback)

createStoragePool(request: protos.google.cloud.netapp.v1.ICreateStoragePoolRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateStoragePoolRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createVolume(request, options)

createVolume(request?: protos.google.cloud.netapp.v1.ICreateVolumeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Volume in a given project and location.

Parameters
Name Description
request ICreateVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting volume. Must be unique within the parent
   *  resource. Must contain only letters, numbers and hyphen, with the first
   *  character a letter, the last a letter or a number,
   *  and a 63 character maximum.
   */
  // const volumeId = 'abc123'
  /**
   *  Required. The volume being created.
   */
  // const volume = {}

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

  async function callCreateVolume() {
    // Construct request
    const request = {
      parent,
      volumeId,
      volume,
    };

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

  callCreateVolume();

createVolume(request, options, callback)

createVolume(request: protos.google.cloud.netapp.v1.ICreateVolumeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateVolumeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createVolume(request, callback)

createVolume(request: protos.google.cloud.netapp.v1.ICreateVolumeRequest, callback: Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateVolumeRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteActiveDirectory(request, options)

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

Delete the active directory specified in the request.

Parameters
Name Description
request IDeleteActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the active directory.
   */
  // const name = 'abc123'

  // Imports the Netapp library
  const {NetAppClient} = require('@google-cloud/netapp').v1;

  // Instantiates a client
  const netappClient = new NetAppClient();

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

    // Run request
    const [operation] =