Class v1.NetAppClient (0.2.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
NameDescription
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

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

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.

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
NameDescription
project string
location string
activeDirectory string
Returns
TypeDescription
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
NameDescription
project string
location string
backupVault string
backup string
Returns
TypeDescription
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
NameDescription
project string
location string
backupPolicy string
Returns
TypeDescription
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
NameDescription
project string
location string
backupVault string
Returns
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   *  Values that do not match this pattern will trigger an INVALID_ARGUMENT
   *  error.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   *  The max supported length is 63 characters.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   *  Values that do not match this pattern will trigger an INVALID_ARGUMENT
   *  error.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  id from the method_signature of Create RPC
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  id from the method_signature of Create RPC
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  Id from the method_signature of Create RPC
   */
  // 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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();

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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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();

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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

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

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
NameDescription
request ICreateActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   *  Values that do not match this pattern will trigger an INVALID_ARGUMENT
   *  error.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateBackupPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateBackupVaultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   *  The max supported length is 63 characters.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   *  Values that do not match this pattern will trigger an INVALID_ARGUMENT
   *  error.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  id from the method_signature of Create RPC
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateSnapshotRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.
   *  This value must start with a lowercase letter followed by up to 62
   *  lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateStoragePoolRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  id from the method_signature of Create RPC
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request ICreateVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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
   *  If auto-generating Id server-side, remove this field and
   *  Id from the method_signature of Create RPC
   */
  // 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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
request IDeleteActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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] = await netappClient.deleteActiveDirectory(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteActiveDirectory();

deleteActiveDirectory(request, options, callback)

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

deleteActiveDirectory(request, callback)

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

deleteBackup(request, options)

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

Warning! This operation will permanently delete the backup.

Parameters
NameDescription
request IDeleteBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteBackup(request, options, callback)

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

deleteBackup(request, callback)

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

deleteBackupPolicy(request, options)

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

Warning! This operation will permanently delete the backup policy.

Parameters
NameDescription
request IDeleteBackupPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteBackupPolicy(request, options, callback)

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

deleteBackupPolicy(request, callback)

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

deleteBackupVault(request, options)

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

Warning! This operation will permanently delete the backup vault.

Parameters
NameDescription
request IDeleteBackupVaultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteBackupVault(request, options, callback)

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

deleteBackupVault(request, callback)

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

deleteKmsConfig(request, options)

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

Warning! This operation will permanently delete the Kms config.

Parameters
NameDescription
request IDeleteKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteKmsConfig(request, options, callback)

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

deleteKmsConfig(request, callback)

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

deleteOperation(request, options, callback)

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

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

Parameters
NameDescription
request DeleteOperationRequest

The request object that will be sent.

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

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

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

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

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example 

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

deleteReplication(request, options)

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

Deletes a replication.

Parameters
NameDescription
request IDeleteReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteReplication(request, options, callback)

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

deleteReplication(request, callback)

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

deleteSnapshot(request, options)

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

Deletes a snapshot.

Parameters
NameDescription
request IDeleteSnapshotRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteSnapshot(request, options, callback)

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

deleteSnapshot(request, callback)

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

deleteStoragePool(request, options)

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

Warning! This operation will permanently delete the storage pool.

Parameters
NameDescription
request IDeleteStoragePoolRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteStoragePool(request, options, callback)

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

deleteStoragePool(request, callback)

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

deleteVolume(request, options)

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

Deletes a single Volume.

Parameters
NameDescription
request IDeleteVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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 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();

deleteVolume(request, options, callback)

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

deleteVolume(request, callback)

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

encryptVolumes(request, options)

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

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

Parameters
NameDescription
request IEncryptVolumesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

encryptVolumes(request, options, callback)

encryptVolumes(request: protos.google.cloud.netapp.v1.IEncryptVolumesRequest, 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
NameDescription
request IEncryptVolumesRequest
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
TypeDescription
void

encryptVolumes(request, callback)

encryptVolumes(request: protos.google.cloud.netapp.v1.IEncryptVolumesRequest, 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
NameDescription
request IEncryptVolumesRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getActiveDirectory(request, options)

getActiveDirectory(request?: protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IActiveDirectory,
        protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | undefined,
        {} | undefined
    ]>;

Describes a specified active directory.

Parameters
NameDescription
request IGetActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. 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 callGetActiveDirectory() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getActiveDirectory(request);
    console.log(response);
  }

  callGetActiveDirectory();

getActiveDirectory(request, options, callback)

getActiveDirectory(request: protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetActiveDirectoryRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getActiveDirectory(request, callback)

getActiveDirectory(request: protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest, callback: Callback<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetActiveDirectoryRequest
callback Callback<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IGetActiveDirectoryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackup(request, options)

getBackup(request?: protos.google.cloud.netapp.v1.IGetBackupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackup,
        protos.google.cloud.netapp.v1.IGetBackupRequest | undefined,
        {} | undefined
    ]>;

Returns the description of the specified backup

Parameters
NameDescription
request IGetBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IGetBackupRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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 callGetBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getBackup(request);
    console.log(response);
  }

  callGetBackup();

getBackup(request, options, callback)

getBackup(request: protos.google.cloud.netapp.v1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackup(request, callback)

getBackup(request: protos.google.cloud.netapp.v1.IGetBackupRequest, callback: Callback<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupRequest
callback Callback<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackupPolicy(request, options)

getBackupPolicy(request?: protos.google.cloud.netapp.v1.IGetBackupPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackupPolicy,
        protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | undefined,
        {} | undefined
    ]>;

Returns the description of the specified backup policy by backup_policy_id.

Parameters
NameDescription
request IGetBackupPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The backupPolicy 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 callGetBackupPolicy() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getBackupPolicy(request);
    console.log(response);
  }

  callGetBackupPolicy();

getBackupPolicy(request, options, callback)

getBackupPolicy(request: protos.google.cloud.netapp.v1.IGetBackupPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackupPolicy(request, callback)

getBackupPolicy(request: protos.google.cloud.netapp.v1.IGetBackupPolicyRequest, callback: Callback<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupPolicyRequest
callback Callback<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IGetBackupPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackupVault(request, options)

getBackupVault(request?: protos.google.cloud.netapp.v1.IGetBackupVaultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackupVault,
        protos.google.cloud.netapp.v1.IGetBackupVaultRequest | undefined,
        {} | undefined
    ]>;

Returns the description of the specified backup vault

Parameters
NameDescription
request IGetBackupVaultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IGetBackupVaultRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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 callGetBackupVault() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getBackupVault(request);
    console.log(response);
  }

  callGetBackupVault();

getBackupVault(request, options, callback)

getBackupVault(request: protos.google.cloud.netapp.v1.IGetBackupVaultRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IGetBackupVaultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupVaultRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IGetBackupVaultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getBackupVault(request, callback)

getBackupVault(request: protos.google.cloud.netapp.v1.IGetBackupVaultRequest, callback: Callback<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IGetBackupVaultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetBackupVaultRequest
callback Callback<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IGetBackupVaultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getKmsConfig(request, options)

getKmsConfig(request?: protos.google.cloud.netapp.v1.IGetKmsConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IKmsConfig,
        protos.google.cloud.netapp.v1.IGetKmsConfigRequest | undefined,
        {} | undefined
    ]>;

Returns the description of the specified KMS config by kms_config_id.

Parameters
NameDescription
request IGetKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IGetKmsConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. 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 callGetKmsConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getKmsConfig(request);
    console.log(response);
  }

  callGetKmsConfig();

getKmsConfig(request, options, callback)

getKmsConfig(request: protos.google.cloud.netapp.v1.IGetKmsConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IGetKmsConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetKmsConfigRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IGetKmsConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getKmsConfig(request, callback)

getKmsConfig(request: protos.google.cloud.netapp.v1.IGetKmsConfigRequest, callback: Callback<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IGetKmsConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetKmsConfigRequest
callback Callback<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IGetKmsConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

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

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

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

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

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

getOperation(request, options, callback)

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

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

Parameters
NameDescription
request GetOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

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

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example 

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

getProjectId()

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

getProjectId(callback)

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

getReplication(request, options)

getReplication(request?: protos.google.cloud.netapp.v1.IGetReplicationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IReplication,
        protos.google.cloud.netapp.v1.IGetReplicationRequest | undefined,
        {} | undefined
    ]>;

Describe a replication for a volume.

Parameters
NameDescription
request IGetReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IGetReplicationRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The replication resource name, in the format
   *  `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 callGetReplication() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getReplication(request);
    console.log(response);
  }

  callGetReplication();

getReplication(request, options, callback)

getReplication(request: protos.google.cloud.netapp.v1.IGetReplicationRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IGetReplicationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetReplicationRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IGetReplicationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getReplication(request, callback)

getReplication(request: protos.google.cloud.netapp.v1.IGetReplicationRequest, callback: Callback<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IGetReplicationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetReplicationRequest
callback Callback<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IGetReplicationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getSnapshot(request, options)

getSnapshot(request?: protos.google.cloud.netapp.v1.IGetSnapshotRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.ISnapshot,
        protos.google.cloud.netapp.v1.IGetSnapshotRequest | undefined,
        {} | undefined
    ]>;

Describe a snapshot for a volume.

Parameters
NameDescription
request IGetSnapshotRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IGetSnapshotRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The snapshot resource name, in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}/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 callGetSnapshot() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getSnapshot(request);
    console.log(response);
  }

  callGetSnapshot();

getSnapshot(request, options, callback)

getSnapshot(request: protos.google.cloud.netapp.v1.IGetSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetSnapshotRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getSnapshot(request, callback)

getSnapshot(request: protos.google.cloud.netapp.v1.IGetSnapshotRequest, callback: Callback<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetSnapshotRequest
callback Callback<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getStoragePool(request, options)

getStoragePool(request?: protos.google.cloud.netapp.v1.IGetStoragePoolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IStoragePool,
        protos.google.cloud.netapp.v1.IGetStoragePoolRequest | undefined,
        {} | undefined
    ]>;

Returns the description of the specified storage pool by poolId.

Parameters
NameDescription
request IGetStoragePoolRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IGetStoragePoolRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. 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 callGetStoragePool() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await netappClient.getStoragePool(request);
    console.log(response);
  }

  callGetStoragePool();

getStoragePool(request, options, callback)

getStoragePool(request: protos.google.cloud.netapp.v1.IGetStoragePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IGetStoragePoolRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetStoragePoolRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IGetStoragePoolRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getStoragePool(request, callback)

getStoragePool(request: protos.google.cloud.netapp.v1.IGetStoragePoolRequest, callback: Callback<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IGetStoragePoolRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetStoragePoolRequest
callback Callback<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IGetStoragePoolRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getVolume(request, options)

getVolume(request?: protos.google.cloud.netapp.v1.IGetVolumeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IVolume,
        protos.google.cloud.netapp.v1.IGetVolumeRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Volume.

Parameters
NameDescription
request IGetVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IGetVolumeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example 

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

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

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

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

    // Run request
    const response = await netappClient.getVolume(request);
    console.log(response);
  }

  callGetVolume();

getVolume(request, options, callback)

getVolume(request: protos.google.cloud.netapp.v1.IGetVolumeRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IGetVolumeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetVolumeRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IGetVolumeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getVolume(request, callback)

getVolume(request: protos.google.cloud.netapp.v1.IGetVolumeRequest, callback: Callback<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IGetVolumeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetVolumeRequest
callback Callback<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IGetVolumeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

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

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

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

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

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

kmsConfigPath(project, location, kmsConfig)

kmsConfigPath(project: string, location: string, kmsConfig: string): string;

Return a fully-qualified kmsConfig resource name string.

Parameters
NameDescription
project string
location string
kmsConfig string
Returns
TypeDescription
string

{string} Resource name string.

listActiveDirectories(request, options)

listActiveDirectories(request?: protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IActiveDirectory[],
        protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest | null,
        protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse
    ]>;

Lists active directories.

Parameters
NameDescription
request IListActiveDirectoriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IActiveDirectory[], protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest | null, protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listActiveDirectoriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listActiveDirectories(request, options, callback)

listActiveDirectories(request: protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse | null | undefined, protos.google.cloud.netapp.v1.IActiveDirectory>): void;
Parameters
NameDescription
request IListActiveDirectoriesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse | null | undefined, protos.google.cloud.netapp.v1.IActiveDirectory>
Returns
TypeDescription
void

listActiveDirectories(request, callback)

listActiveDirectories(request: protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse | null | undefined, protos.google.cloud.netapp.v1.IActiveDirectory>): void;
Parameters
NameDescription
request IListActiveDirectoriesRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, protos.google.cloud.netapp.v1.IListActiveDirectoriesResponse | null | undefined, protos.google.cloud.netapp.v1.IActiveDirectory>
Returns
TypeDescription
void

listActiveDirectoriesAsync(request, options)

listActiveDirectoriesAsync(request?: protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IActiveDirectory>;

Equivalent to listActiveDirectories, but returns an iterable object.

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

Parameters
NameDescription
request IListActiveDirectoriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IActiveDirectory>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListActiveDirectoriesRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, the server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListActiveDirectories();

listActiveDirectoriesStream(request, options)

listActiveDirectoriesStream(request?: protos.google.cloud.netapp.v1.IListActiveDirectoriesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListActiveDirectoriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listActiveDirectoriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackupPolicies(request, options)

listBackupPolicies(request?: protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackupPolicy[],
        protos.google.cloud.netapp.v1.IListBackupPoliciesRequest | null,
        protos.google.cloud.netapp.v1.IListBackupPoliciesResponse
    ]>;

Returns list of all available backup policies.

Parameters
NameDescription
request IListBackupPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackupPolicy[], protos.google.cloud.netapp.v1.IListBackupPoliciesRequest | null, protos.google.cloud.netapp.v1.IListBackupPoliciesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBackupPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackupPolicies(request, options, callback)

listBackupPolicies(request: protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, protos.google.cloud.netapp.v1.IListBackupPoliciesResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupPolicy>): void;
Parameters
NameDescription
request IListBackupPoliciesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, protos.google.cloud.netapp.v1.IListBackupPoliciesResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupPolicy>
Returns
TypeDescription
void

listBackupPolicies(request, callback)

listBackupPolicies(request: protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, protos.google.cloud.netapp.v1.IListBackupPoliciesResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupPolicy>): void;
Parameters
NameDescription
request IListBackupPoliciesRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, protos.google.cloud.netapp.v1.IListBackupPoliciesResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupPolicy>
Returns
TypeDescription
void

listBackupPoliciesAsync(request, options)

listBackupPoliciesAsync(request?: protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IBackupPolicy>;

Equivalent to listBackupPolicies, but returns an iterable object.

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

Parameters
NameDescription
request IListBackupPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IBackupPolicy>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListBackupPoliciesRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, the server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListBackupPolicies();

listBackupPoliciesStream(request, options)

listBackupPoliciesStream(request?: protos.google.cloud.netapp.v1.IListBackupPoliciesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListBackupPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBackupPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackups(request, options)

listBackups(request?: protos.google.cloud.netapp.v1.IListBackupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackup[],
        protos.google.cloud.netapp.v1.IListBackupsRequest | null,
        protos.google.cloud.netapp.v1.IListBackupsResponse
    ]>;

Returns descriptions of all backups for a backupVault.

Parameters
NameDescription
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackup[], protos.google.cloud.netapp.v1.IListBackupsRequest | null, protos.google.cloud.netapp.v1.IListBackupsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackups(request, options, callback)

listBackups(request: protos.google.cloud.netapp.v1.IListBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupsRequest, protos.google.cloud.netapp.v1.IListBackupsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackup>): void;
Parameters
NameDescription
request IListBackupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupsRequest, protos.google.cloud.netapp.v1.IListBackupsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackup>
Returns
TypeDescription
void

listBackups(request, callback)

listBackups(request: protos.google.cloud.netapp.v1.IListBackupsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupsRequest, protos.google.cloud.netapp.v1.IListBackupsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackup>): void;
Parameters
NameDescription
request IListBackupsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupsRequest, protos.google.cloud.netapp.v1.IListBackupsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackup>
Returns
TypeDescription
void

listBackupsAsync(request, options)

listBackupsAsync(request?: protos.google.cloud.netapp.v1.IListBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IBackup>;

Equivalent to listBackups, but returns an iterable object.

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

Parameters
NameDescription
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IBackup>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The backupVault for which to retrieve backup information,
   *  in the format
   *  `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
   *  To retrieve backup information for all locations, use "-" for the
   *  `{location}` value.
   *  To retrieve backup information for all backupVaults, use "-" for the
   *  `{backup_vault_id}` value.
   *  To retrieve backup information for a volume, use "-" for the
   *  `{backup_vault_id}` value and specify volume full name with the filter.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. The service may return fewer
   *  than this value. The maximum value
   *  is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  The standard list filter.
   *  If specified, backups will be returned based on the attribute name that
   *  matches the filter expression. If empty, then no backups are filtered out.
   *  See https://google.aip.dev/160
   */
  // const filter = 'abc123'

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

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

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

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

  callListBackups();

listBackupsStream(request, options)

listBackupsStream(request?: protos.google.cloud.netapp.v1.IListBackupsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackupVaults(request, options)

listBackupVaults(request?: protos.google.cloud.netapp.v1.IListBackupVaultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IBackupVault[],
        protos.google.cloud.netapp.v1.IListBackupVaultsRequest | null,
        protos.google.cloud.netapp.v1.IListBackupVaultsResponse
    ]>;

Returns list of all available backup vaults.

Parameters
NameDescription
request IListBackupVaultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IBackupVault[], protos.google.cloud.netapp.v1.IListBackupVaultsRequest | null, protos.google.cloud.netapp.v1.IListBackupVaultsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBackupVaultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackupVaults(request, options, callback)

listBackupVaults(request: protos.google.cloud.netapp.v1.IListBackupVaultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupVaultsRequest, protos.google.cloud.netapp.v1.IListBackupVaultsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupVault>): void;
Parameters
NameDescription
request IListBackupVaultsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupVaultsRequest, protos.google.cloud.netapp.v1.IListBackupVaultsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupVault>
Returns
TypeDescription
void

listBackupVaults(request, callback)

listBackupVaults(request: protos.google.cloud.netapp.v1.IListBackupVaultsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListBackupVaultsRequest, protos.google.cloud.netapp.v1.IListBackupVaultsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupVault>): void;
Parameters
NameDescription
request IListBackupVaultsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListBackupVaultsRequest, protos.google.cloud.netapp.v1.IListBackupVaultsResponse | null | undefined, protos.google.cloud.netapp.v1.IBackupVault>
Returns
TypeDescription
void

listBackupVaultsAsync(request, options)

listBackupVaultsAsync(request?: protos.google.cloud.netapp.v1.IListBackupVaultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IBackupVault>;

Equivalent to listBackupVaults, but returns an iterable object.

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

Parameters
NameDescription
request IListBackupVaultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IBackupVault>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location for which to retrieve backupVault information,
   *  in the format
   *  `projects/{project_id}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'

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

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

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

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

  callListBackupVaults();

listBackupVaultsStream(request, options)

listBackupVaultsStream(request?: protos.google.cloud.netapp.v1.IListBackupVaultsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListBackupVaultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBackupVaultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listKmsConfigs(request, options)

listKmsConfigs(request?: protos.google.cloud.netapp.v1.IListKmsConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IKmsConfig[],
        protos.google.cloud.netapp.v1.IListKmsConfigsRequest | null,
        protos.google.cloud.netapp.v1.IListKmsConfigsResponse
    ]>;

Returns descriptions of all KMS configs owned by the caller.

Parameters
NameDescription
request IListKmsConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IKmsConfig[], protos.google.cloud.netapp.v1.IListKmsConfigsRequest | null, protos.google.cloud.netapp.v1.IListKmsConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listKmsConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listKmsConfigs(request, options, callback)

listKmsConfigs(request: protos.google.cloud.netapp.v1.IListKmsConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListKmsConfigsRequest, protos.google.cloud.netapp.v1.IListKmsConfigsResponse | null | undefined, protos.google.cloud.netapp.v1.IKmsConfig>): void;
Parameters
NameDescription
request IListKmsConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListKmsConfigsRequest, protos.google.cloud.netapp.v1.IListKmsConfigsResponse | null | undefined, protos.google.cloud.netapp.v1.IKmsConfig>
Returns
TypeDescription
void

listKmsConfigs(request, callback)

listKmsConfigs(request: protos.google.cloud.netapp.v1.IListKmsConfigsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListKmsConfigsRequest, protos.google.cloud.netapp.v1.IListKmsConfigsResponse | null | undefined, protos.google.cloud.netapp.v1.IKmsConfig>): void;
Parameters
NameDescription
request IListKmsConfigsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListKmsConfigsRequest, protos.google.cloud.netapp.v1.IListKmsConfigsResponse | null | undefined, protos.google.cloud.netapp.v1.IKmsConfig>
Returns
TypeDescription
void

listKmsConfigsAsync(request, options)

listKmsConfigsAsync(request?: protos.google.cloud.netapp.v1.IListKmsConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IKmsConfig>;

Equivalent to listKmsConfigs, but returns an iterable object.

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

Parameters
NameDescription
request IListKmsConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IKmsConfig>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'

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

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

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

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

  callListKmsConfigs();

listKmsConfigsStream(request, options)

listKmsConfigsStream(request?: protos.google.cloud.netapp.v1.IListKmsConfigsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListKmsConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listKmsConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

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

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

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

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

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

listOperationsAsync(request, options)

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

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

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

Parameters
NameDescription
request ListOperationsRequest

The request object that will be sent.

options CallOptions

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

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.

Example 

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

listReplications(request, options)

listReplications(request?: protos.google.cloud.netapp.v1.IListReplicationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IReplication[],
        protos.google.cloud.netapp.v1.IListReplicationsRequest | null,
        protos.google.cloud.netapp.v1.IListReplicationsResponse
    ]>;

Returns descriptions of all replications for a volume.

Parameters
NameDescription
request IListReplicationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IReplication[], protos.google.cloud.netapp.v1.IListReplicationsRequest | null, protos.google.cloud.netapp.v1.IListReplicationsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listReplicationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listReplications(request, options, callback)

listReplications(request: protos.google.cloud.netapp.v1.IListReplicationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListReplicationsRequest, protos.google.cloud.netapp.v1.IListReplicationsResponse | null | undefined, protos.google.cloud.netapp.v1.IReplication>): void;
Parameters
NameDescription
request IListReplicationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListReplicationsRequest, protos.google.cloud.netapp.v1.IListReplicationsResponse | null | undefined, protos.google.cloud.netapp.v1.IReplication>
Returns
TypeDescription
void

listReplications(request, callback)

listReplications(request: protos.google.cloud.netapp.v1.IListReplicationsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListReplicationsRequest, protos.google.cloud.netapp.v1.IListReplicationsResponse | null | undefined, protos.google.cloud.netapp.v1.IReplication>): void;
Parameters
NameDescription
request IListReplicationsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListReplicationsRequest, protos.google.cloud.netapp.v1.IListReplicationsResponse | null | undefined, protos.google.cloud.netapp.v1.IReplication>
Returns
TypeDescription
void

listReplicationsAsync(request, options)

listReplicationsAsync(request?: protos.google.cloud.netapp.v1.IListReplicationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IReplication>;

Equivalent to listReplications, but returns an iterable object.

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

Parameters
NameDescription
request IListReplicationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IReplication>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The volume for which to retrieve replication information,
   *  in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'

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

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

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

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

  callListReplications();

listReplicationsStream(request, options)

listReplicationsStream(request?: protos.google.cloud.netapp.v1.IListReplicationsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListReplicationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listReplicationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSnapshots(request, options)

listSnapshots(request?: protos.google.cloud.netapp.v1.IListSnapshotsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.ISnapshot[],
        protos.google.cloud.netapp.v1.IListSnapshotsRequest | null,
        protos.google.cloud.netapp.v1.IListSnapshotsResponse
    ]>;

Returns descriptions of all snapshots for a volume.

Parameters
NameDescription
request IListSnapshotsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.ISnapshot[], protos.google.cloud.netapp.v1.IListSnapshotsRequest | null, protos.google.cloud.netapp.v1.IListSnapshotsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listSnapshotsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSnapshots(request, options, callback)

listSnapshots(request: protos.google.cloud.netapp.v1.IListSnapshotsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListSnapshotsRequest, protos.google.cloud.netapp.v1.IListSnapshotsResponse | null | undefined, protos.google.cloud.netapp.v1.ISnapshot>): void;
Parameters
NameDescription
request IListSnapshotsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListSnapshotsRequest, protos.google.cloud.netapp.v1.IListSnapshotsResponse | null | undefined, protos.google.cloud.netapp.v1.ISnapshot>
Returns
TypeDescription
void

listSnapshots(request, callback)

listSnapshots(request: protos.google.cloud.netapp.v1.IListSnapshotsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListSnapshotsRequest, protos.google.cloud.netapp.v1.IListSnapshotsResponse | null | undefined, protos.google.cloud.netapp.v1.ISnapshot>): void;
Parameters
NameDescription
request IListSnapshotsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListSnapshotsRequest, protos.google.cloud.netapp.v1.IListSnapshotsResponse | null | undefined, protos.google.cloud.netapp.v1.ISnapshot>
Returns
TypeDescription
void

listSnapshotsAsync(request, options)

listSnapshotsAsync(request?: protos.google.cloud.netapp.v1.IListSnapshotsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.ISnapshot>;

Equivalent to listSnapshots, but returns an iterable object.

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

Parameters
NameDescription
request IListSnapshotsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.ISnapshot>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The volume for which to retrieve snapshot information,
   *  in the format
   *  `projects/{project_id}/locations/{location}/volumes/{volume_id}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'

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

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

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

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

  callListSnapshots();

listSnapshotsStream(request, options)

listSnapshotsStream(request?: protos.google.cloud.netapp.v1.IListSnapshotsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListSnapshotsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSnapshotsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listStoragePools(request, options)

listStoragePools(request?: protos.google.cloud.netapp.v1.IListStoragePoolsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IStoragePool[],
        protos.google.cloud.netapp.v1.IListStoragePoolsRequest | null,
        protos.google.cloud.netapp.v1.IListStoragePoolsResponse
    ]>;

Returns descriptions of all storage pools owned by the caller.

Parameters
NameDescription
request IListStoragePoolsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IStoragePool[], protos.google.cloud.netapp.v1.IListStoragePoolsRequest | null, protos.google.cloud.netapp.v1.IListStoragePoolsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listStoragePoolsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listStoragePools(request, options, callback)

listStoragePools(request: protos.google.cloud.netapp.v1.IListStoragePoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListStoragePoolsRequest, protos.google.cloud.netapp.v1.IListStoragePoolsResponse | null | undefined, protos.google.cloud.netapp.v1.IStoragePool>): void;
Parameters
NameDescription
request IListStoragePoolsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListStoragePoolsRequest, protos.google.cloud.netapp.v1.IListStoragePoolsResponse | null | undefined, protos.google.cloud.netapp.v1.IStoragePool>
Returns
TypeDescription
void

listStoragePools(request, callback)

listStoragePools(request: protos.google.cloud.netapp.v1.IListStoragePoolsRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListStoragePoolsRequest, protos.google.cloud.netapp.v1.IListStoragePoolsResponse | null | undefined, protos.google.cloud.netapp.v1.IStoragePool>): void;
Parameters
NameDescription
request IListStoragePoolsRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListStoragePoolsRequest, protos.google.cloud.netapp.v1.IListStoragePoolsResponse | null | undefined, protos.google.cloud.netapp.v1.IStoragePool>
Returns
TypeDescription
void

listStoragePoolsAsync(request, options)

listStoragePoolsAsync(request?: protos.google.cloud.netapp.v1.IListStoragePoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IStoragePool>;

Equivalent to listStoragePools, but returns an iterable object.

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

Parameters
NameDescription
request IListStoragePoolsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IStoragePool>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'

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

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

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

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

  callListStoragePools();

listStoragePoolsStream(request, options)

listStoragePoolsStream(request?: protos.google.cloud.netapp.v1.IListStoragePoolsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListStoragePoolsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listStoragePoolsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVolumes(request, options)

listVolumes(request?: protos.google.cloud.netapp.v1.IListVolumesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IVolume[],
        protos.google.cloud.netapp.v1.IListVolumesRequest | null,
        protos.google.cloud.netapp.v1.IListVolumesResponse
    ]>;

Lists Volumes in a given project.

Parameters
NameDescription
request IListVolumesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IVolume[], protos.google.cloud.netapp.v1.IListVolumesRequest | null, protos.google.cloud.netapp.v1.IListVolumesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listVolumesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVolumes(request, options, callback)

listVolumes(request: protos.google.cloud.netapp.v1.IListVolumesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListVolumesRequest, protos.google.cloud.netapp.v1.IListVolumesResponse | null | undefined, protos.google.cloud.netapp.v1.IVolume>): void;
Parameters
NameDescription
request IListVolumesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.netapp.v1.IListVolumesRequest, protos.google.cloud.netapp.v1.IListVolumesResponse | null | undefined, protos.google.cloud.netapp.v1.IVolume>
Returns
TypeDescription
void

listVolumes(request, callback)

listVolumes(request: protos.google.cloud.netapp.v1.IListVolumesRequest, callback: PaginationCallback<protos.google.cloud.netapp.v1.IListVolumesRequest, protos.google.cloud.netapp.v1.IListVolumesResponse | null | undefined, protos.google.cloud.netapp.v1.IVolume>): void;
Parameters
NameDescription
request IListVolumesRequest
callback PaginationCallback<protos.google.cloud.netapp.v1.IListVolumesRequest, protos.google.cloud.netapp.v1.IListVolumesResponse | null | undefined, protos.google.cloud.netapp.v1.IVolume>
Returns
TypeDescription
void

listVolumesAsync(request, options)

listVolumesAsync(request?: protos.google.cloud.netapp.v1.IListVolumesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.netapp.v1.IVolume>;

Equivalent to listVolumes, but returns an iterable object.

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

Parameters
NameDescription
request IListVolumesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.netapp.v1.IVolume>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListVolumesRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, the server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListVolumes();

listVolumesStream(request, options)

listVolumesStream(request?: protos.google.cloud.netapp.v1.IListVolumesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListVolumesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVolumesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchActiveDirectoryFromActiveDirectoryName(activeDirectoryName)

matchActiveDirectoryFromActiveDirectoryName(activeDirectoryName: string): string | number;

Parse the active_directory from ActiveDirectory resource.

Parameter
NameDescription
activeDirectoryName string

A fully-qualified path representing ActiveDirectory resource.

Returns
TypeDescription
string | number

{string} A string representing the active_directory.

matchBackupFromBackupName(backupName)

matchBackupFromBackupName(backupName: string): string | number;

Parse the backup from Backup resource.

Parameter
NameDescription
backupName string

A fully-qualified path representing Backup resource.

Returns
TypeDescription
string | number

{string} A string representing the backup.

matchBackupPolicyFromBackupPolicyName(backupPolicyName)

matchBackupPolicyFromBackupPolicyName(backupPolicyName: string): string | number;

Parse the backup_policy from BackupPolicy resource.

Parameter
NameDescription
backupPolicyName string

A fully-qualified path representing BackupPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the backup_policy.

matchBackupVaultFromBackupName(backupName)

matchBackupVaultFromBackupName(backupName: string): string | number;

Parse the backup_vault from Backup resource.

Parameter
NameDescription
backupName string

A fully-qualified path representing Backup resource.

Returns
TypeDescription
string | number

{string} A string representing the backup_vault.

matchBackupVaultFromBackupVaultName(backupVaultName)

matchBackupVaultFromBackupVaultName(backupVaultName: string): string | number;

Parse the backup_vault from BackupVault resource.

Parameter
NameDescription
backupVaultName string

A fully-qualified path representing BackupVault resource.

Returns
TypeDescription
string | number

{string} A string representing the backup_vault.

matchKmsConfigFromKmsConfigName(kmsConfigName)

matchKmsConfigFromKmsConfigName(kmsConfigName: string): string | number;

Parse the kms_config from KmsConfig resource.

Parameter
NameDescription
kmsConfigName string

A fully-qualified path representing KmsConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the kms_config.

matchLocationFromActiveDirectoryName(activeDirectoryName)

matchLocationFromActiveDirectoryName(activeDirectoryName: string): string | number;

Parse the location from ActiveDirectory resource.

Parameter
NameDescription
activeDirectoryName string

A fully-qualified path representing ActiveDirectory resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBackupName(backupName)

matchLocationFromBackupName(backupName: string): string | number;

Parse the location from Backup resource.

Parameter
NameDescription
backupName string

A fully-qualified path representing Backup resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBackupPolicyName(backupPolicyName)

matchLocationFromBackupPolicyName(backupPolicyName: string): string | number;

Parse the location from BackupPolicy resource.

Parameter
NameDescription
backupPolicyName string

A fully-qualified path representing BackupPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBackupVaultName(backupVaultName)

matchLocationFromBackupVaultName(backupVaultName: string): string | number;

Parse the location from BackupVault resource.

Parameter
NameDescription
backupVaultName string

A fully-qualified path representing BackupVault resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromKmsConfigName(kmsConfigName)

matchLocationFromKmsConfigName(kmsConfigName: string): string | number;

Parse the location from KmsConfig resource.

Parameter
NameDescription
kmsConfigName string

A fully-qualified path representing KmsConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromReplicationName(replicationName)

matchLocationFromReplicationName(replicationName: string): string | number;

Parse the location from Replication resource.

Parameter
NameDescription
replicationName string

A fully-qualified path representing Replication resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSnapshotName(snapshotName)

matchLocationFromSnapshotName(snapshotName: string): string | number;

Parse the location from Snapshot resource.

Parameter
NameDescription
snapshotName string

A fully-qualified path representing Snapshot resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromStoragePoolName(storagePoolName)

matchLocationFromStoragePoolName(storagePoolName: string): string | number;

Parse the location from StoragePool resource.

Parameter
NameDescription
storagePoolName string

A fully-qualified path representing StoragePool resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromVolumeName(volumeName)

matchLocationFromVolumeName(volumeName: string): string | number;

Parse the location from Volume resource.

Parameter
NameDescription
volumeName string

A fully-qualified path representing Volume resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromActiveDirectoryName(activeDirectoryName)

matchProjectFromActiveDirectoryName(activeDirectoryName: string): string | number;

Parse the project from ActiveDirectory resource.

Parameter
NameDescription
activeDirectoryName string

A fully-qualified path representing ActiveDirectory resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBackupName(backupName)

matchProjectFromBackupName(backupName: string): string | number;

Parse the project from Backup resource.

Parameter
NameDescription
backupName string

A fully-qualified path representing Backup resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBackupPolicyName(backupPolicyName)

matchProjectFromBackupPolicyName(backupPolicyName: string): string | number;

Parse the project from BackupPolicy resource.

Parameter
NameDescription
backupPolicyName string

A fully-qualified path representing BackupPolicy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBackupVaultName(backupVaultName)

matchProjectFromBackupVaultName(backupVaultName: string): string | number;

Parse the project from BackupVault resource.

Parameter
NameDescription
backupVaultName string

A fully-qualified path representing BackupVault resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromKmsConfigName(kmsConfigName)

matchProjectFromKmsConfigName(kmsConfigName: string): string | number;

Parse the project from KmsConfig resource.

Parameter
NameDescription
kmsConfigName string

A fully-qualified path representing KmsConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromReplicationName(replicationName)

matchProjectFromReplicationName(replicationName: string): string | number;

Parse the project from Replication resource.

Parameter
NameDescription
replicationName string

A fully-qualified path representing Replication resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSnapshotName(snapshotName)

matchProjectFromSnapshotName(snapshotName: string): string | number;

Parse the project from Snapshot resource.

Parameter
NameDescription
snapshotName string

A fully-qualified path representing Snapshot resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromStoragePoolName(storagePoolName)

matchProjectFromStoragePoolName(storagePoolName: string): string | number;

Parse the project from StoragePool resource.

Parameter
NameDescription
storagePoolName string

A fully-qualified path representing StoragePool resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromVolumeName(volumeName)

matchProjectFromVolumeName(volumeName: string): string | number;

Parse the project from Volume resource.

Parameter
NameDescription
volumeName string

A fully-qualified path representing Volume resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchReplicationFromReplicationName(replicationName)

matchReplicationFromReplicationName(replicationName: string): string | number;

Parse the replication from Replication resource.

Parameter
NameDescription
replicationName string

A fully-qualified path representing Replication resource.

Returns
TypeDescription
string | number

{string} A string representing the replication.

matchSnapshotFromSnapshotName(snapshotName)

matchSnapshotFromSnapshotName(snapshotName: string): string | number;

Parse the snapshot from Snapshot resource.

Parameter
NameDescription
snapshotName string

A fully-qualified path representing Snapshot resource.

Returns
TypeDescription
string | number

{string} A string representing the snapshot.

matchStoragePoolFromStoragePoolName(storagePoolName)

matchStoragePoolFromStoragePoolName(storagePoolName: string): string | number;

Parse the storage_pool from StoragePool resource.

Parameter
NameDescription
storagePoolName string

A fully-qualified path representing StoragePool resource.

Returns
TypeDescription
string | number

{string} A string representing the storage_pool.

matchVolumeFromReplicationName(replicationName)

matchVolumeFromReplicationName(replicationName: string): string | number;

Parse the volume from Replication resource.

Parameter
NameDescription
replicationName string

A fully-qualified path representing Replication resource.

Returns
TypeDescription
string | number

{string} A string representing the volume.

matchVolumeFromSnapshotName(snapshotName)

matchVolumeFromSnapshotName(snapshotName: string): string | number;

Parse the volume from Snapshot resource.

Parameter
NameDescription
snapshotName string

A fully-qualified path representing Snapshot resource.

Returns
TypeDescription
string | number

{string} A string representing the volume.

matchVolumeFromVolumeName(volumeName)

matchVolumeFromVolumeName(volumeName: string): string | number;

Parse the volume from Volume resource.

Parameter
NameDescription
volumeName string

A fully-qualified path representing Volume resource.

Returns
TypeDescription
string | number

{string} A string representing the volume.

replicationPath(project, location, volume, replication)

replicationPath(project: string, location: string, volume: string, replication: string): string;

Return a fully-qualified replication resource name string.

Parameters
NameDescription
project string
location string
volume string
replication string
Returns
TypeDescription
string

{string} Resource name string.

resumeReplication(request, options)

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

Resume Cross Region Replication.

Parameters
NameDescription
request IResumeReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 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();

resumeReplication(request, options, callback)

resumeReplication(request: protos.google.cloud.netapp.v1.IResumeReplicationRequest, 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
NameDescription
request IResumeReplicationRequest
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
TypeDescription
void

resumeReplication(request, callback)

resumeReplication(request: protos.google.cloud.netapp.v1.IResumeReplicationRequest, 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
NameDescription
request IResumeReplicationRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

reverseReplicationDirection(request, options)

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

Reverses direction of replication. Source becomes destination and destination becomes source.

Parameters
NameDescription
request IReverseReplicationDirectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 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();

reverseReplicationDirection(request, options, callback)

reverseReplicationDirection(request: protos.google.cloud.netapp.v1.IReverseReplicationDirectionRequest, 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
NameDescription
request IReverseReplicationDirectionRequest
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
TypeDescription
void

reverseReplicationDirection(request, callback)

reverseReplicationDirection(request: protos.google.cloud.netapp.v1.IReverseReplicationDirectionRequest, 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
NameDescription
request IReverseReplicationDirectionRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

revertVolume(request, options)

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

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

Parameters
NameDescription
request IRevertVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

revertVolume(request, options, callback)

revertVolume(request: protos.google.cloud.netapp.v1.IRevertVolumeRequest, 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
NameDescription
request IRevertVolumeRequest
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
TypeDescription
void

revertVolume(request, callback)

revertVolume(request: protos.google.cloud.netapp.v1.IRevertVolumeRequest, 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
NameDescription
request IRevertVolumeRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

snapshotPath(project, location, volume, snapshot)

snapshotPath(project: string, location: string, volume: string, snapshot: string): string;

Return a fully-qualified snapshot resource name string.

Parameters
NameDescription
project string
location string
volume string
snapshot string
Returns
TypeDescription
string

{string} Resource name string.

stopReplication(request, options)

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

Stop Cross Region Replication.

Parameters
NameDescription
request IStopReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 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();

stopReplication(request, options, callback)

stopReplication(request: protos.google.cloud.netapp.v1.IStopReplicationRequest, 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
NameDescription
request IStopReplicationRequest
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
TypeDescription
void

stopReplication(request, callback)

stopReplication(request: protos.google.cloud.netapp.v1.IStopReplicationRequest, 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
NameDescription
request IStopReplicationRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

storagePoolPath(project, location, storagePool)

storagePoolPath(project: string, location: string, storagePool: string): string;

Return a fully-qualified storagePool resource name string.

Parameters
NameDescription
project string
location string
storagePool string
Returns
TypeDescription
string

{string} Resource name string.

updateActiveDirectory(request, options)

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

Update the parameters of an active directories.

Parameters
NameDescription
request IUpdateActiveDirectoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateActiveDirectory(request, options, callback)

updateActiveDirectory(request: protos.google.cloud.netapp.v1.IUpdateActiveDirectoryRequest, 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
NameDescription
request IUpdateActiveDirectoryRequest
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
TypeDescription
void

updateActiveDirectory(request, callback)

updateActiveDirectory(request: protos.google.cloud.netapp.v1.IUpdateActiveDirectoryRequest, 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
NameDescription
request IUpdateActiveDirectoryRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IActiveDirectory, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateBackup(request, options)

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

Update backup with full spec.

Parameters
NameDescription
request IUpdateBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateBackup(request, options, callback)

updateBackup(request: protos.google.cloud.netapp.v1.IUpdateBackupRequest, 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
NameDescription
request IUpdateBackupRequest
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
TypeDescription
void

updateBackup(request, callback)

updateBackup(request: protos.google.cloud.netapp.v1.IUpdateBackupRequest, 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
NameDescription
request IUpdateBackupRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackup, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateBackupPolicy(request, options)

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

Updates settings of a specific backup policy.

Parameters
NameDescription
request IUpdateBackupPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateBackupPolicy(request, options, callback)

updateBackupPolicy(request: protos.google.cloud.netapp.v1.IUpdateBackupPolicyRequest, 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
NameDescription
request IUpdateBackupPolicyRequest
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
TypeDescription
void

updateBackupPolicy(request, callback)

updateBackupPolicy(request: protos.google.cloud.netapp.v1.IUpdateBackupPolicyRequest, 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
NameDescription
request IUpdateBackupPolicyRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupPolicy, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateBackupVault(request, options)

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

Updates the settings of a specific backup vault.

Parameters
NameDescription
request IUpdateBackupVaultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateBackupVault(request, options, callback)

updateBackupVault(request: protos.google.cloud.netapp.v1.IUpdateBackupVaultRequest, 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
NameDescription
request IUpdateBackupVaultRequest
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
TypeDescription
void

updateBackupVault(request, callback)

updateBackupVault(request: protos.google.cloud.netapp.v1.IUpdateBackupVaultRequest, 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
NameDescription
request IUpdateBackupVaultRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IBackupVault, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateKmsConfig(request, options)

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

Updates the Kms config properties with the full spec

Parameters
NameDescription
request IUpdateKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateKmsConfig(request, options, callback)

updateKmsConfig(request: protos.google.cloud.netapp.v1.IUpdateKmsConfigRequest, 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
NameDescription
request IUpdateKmsConfigRequest
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
TypeDescription
void

updateKmsConfig(request, callback)

updateKmsConfig(request: protos.google.cloud.netapp.v1.IUpdateKmsConfigRequest, 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
NameDescription
request IUpdateKmsConfigRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IKmsConfig, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateReplication(request, options)

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

Updates the settings of a specific replication.

Parameters
NameDescription
request IUpdateReplicationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateReplication(request, options, callback)

updateReplication(request: protos.google.cloud.netapp.v1.IUpdateReplicationRequest, 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
NameDescription
request IUpdateReplicationRequest
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
TypeDescription
void

updateReplication(request, callback)

updateReplication(request: protos.google.cloud.netapp.v1.IUpdateReplicationRequest, 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
NameDescription
request IUpdateReplicationRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IReplication, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateSnapshot(request, options)

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

Updates the settings of a specific snapshot.

Parameters
NameDescription
request IUpdateSnapshotRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateSnapshot(request, options, callback)

updateSnapshot(request: protos.google.cloud.netapp.v1.IUpdateSnapshotRequest, 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
NameDescription
request IUpdateSnapshotRequest
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
TypeDescription
void

updateSnapshot(request, callback)

updateSnapshot(request: protos.google.cloud.netapp.v1.IUpdateSnapshotRequest, 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
NameDescription
request IUpdateSnapshotRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.ISnapshot, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateStoragePool(request, options)

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

Updates the storage pool properties with the full spec

Parameters
NameDescription
request IUpdateStoragePoolRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateStoragePool(request, options, callback)

updateStoragePool(request: protos.google.cloud.netapp.v1.IUpdateStoragePoolRequest, 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
NameDescription
request IUpdateStoragePoolRequest
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
TypeDescription
void

updateStoragePool(request, callback)

updateStoragePool(request: protos.google.cloud.netapp.v1.IUpdateStoragePoolRequest, 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
NameDescription
request IUpdateStoragePoolRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IStoragePool, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateVolume(request, options)

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

Updates the parameters of a single Volume.

Parameters
NameDescription
request IUpdateVolumeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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. 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();

updateVolume(request, options, callback)

updateVolume(request: protos.google.cloud.netapp.v1.IUpdateVolumeRequest, 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
NameDescription
request IUpdateVolumeRequest
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
TypeDescription
void

updateVolume(request, callback)

updateVolume(request: protos.google.cloud.netapp.v1.IUpdateVolumeRequest, 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
NameDescription
request IUpdateVolumeRequest
callback Callback<LROperation<protos.google.cloud.netapp.v1.IVolume, protos.google.cloud.netapp.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

verifyKmsConfig(request, options)

verifyKmsConfig(request?: protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse,
        protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | undefined,
        {} | undefined
    ]>;

Verifies KMS config reachability.

Parameters
NameDescription
request IVerifyKmsConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse, protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing VerifyKmsConfigResponse. 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 KMS Config to be verified.
   */
  // const name = 'abc123'

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

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

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

    // Run request
    const response = await netappClient.verifyKmsConfig(request);
    console.log(response);
  }

  callVerifyKmsConfig();

verifyKmsConfig(request, options, callback)

verifyKmsConfig(request: protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse, protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IVerifyKmsConfigRequest
options CallOptions
callback Callback<protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse, protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

verifyKmsConfig(request, callback)

verifyKmsConfig(request: protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest, callback: Callback<protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse, protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IVerifyKmsConfigRequest
callback Callback<protos.google.cloud.netapp.v1.IVerifyKmsConfigResponse, protos.google.cloud.netapp.v1.IVerifyKmsConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

volumePath(project, location, volume)

volumePath(project: string, location: string, volume: string): string;

Return a fully-qualified volume resource name string.

Parameters
NameDescription
project string
location string
volume string
Returns
TypeDescription
string

{string} Resource name string.