Class NetAppClient (0.32.0)

GitHub RepositoryProduct Reference

Service Description: NetApp Files Google Cloud Service

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StoragePoolName name = StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]");
   StoragePool response = netAppClient.getStoragePool(name);
 }
 

Note: close() needs to be called on the NetAppClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListStoragePools

Returns descriptions of all storage pools owned by the caller.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listStoragePools(ListStoragePoolsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listStoragePools(LocationName parent)

  • listStoragePools(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listStoragePoolsPagedCallable()

  • listStoragePoolsCallable()

CreateStoragePool

Creates a new storage pool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createStoragePoolAsync(CreateStoragePoolRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createStoragePoolAsync(LocationName parent, StoragePool storagePool, String storagePoolId)

  • createStoragePoolAsync(String parent, StoragePool storagePool, String storagePoolId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createStoragePoolOperationCallable()

  • createStoragePoolCallable()

GetStoragePool

Returns the description of the specified storage pool by poolId.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getStoragePool(GetStoragePoolRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getStoragePool(StoragePoolName name)

  • getStoragePool(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getStoragePoolCallable()

UpdateStoragePool

Updates the storage pool properties with the full spec

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateStoragePoolAsync(UpdateStoragePoolRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateStoragePoolAsync(StoragePool storagePool, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateStoragePoolOperationCallable()

  • updateStoragePoolCallable()

DeleteStoragePool

Warning! This operation will permanently delete the storage pool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteStoragePoolAsync(DeleteStoragePoolRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteStoragePoolAsync(StoragePoolName name)

  • deleteStoragePoolAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteStoragePoolOperationCallable()

  • deleteStoragePoolCallable()

SwitchActiveReplicaZone

This operation will switch the active/replica zone for a regional storagePool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • switchActiveReplicaZoneAsync(SwitchActiveReplicaZoneRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • switchActiveReplicaZoneOperationCallable()

  • switchActiveReplicaZoneCallable()

ListVolumes

Lists Volumes in a given project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listVolumes(ListVolumesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listVolumes(LocationName parent)

  • listVolumes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listVolumesPagedCallable()

  • listVolumesCallable()

GetVolume

Gets details of a single Volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getVolume(GetVolumeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getVolume(VolumeName name)

  • getVolume(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getVolumeCallable()

CreateVolume

Creates a new Volume in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createVolumeAsync(CreateVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createVolumeAsync(LocationName parent, Volume volume, String volumeId)

  • createVolumeAsync(String parent, Volume volume, String volumeId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createVolumeOperationCallable()

  • createVolumeCallable()

UpdateVolume

Updates the parameters of a single Volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateVolumeAsync(UpdateVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateVolumeAsync(Volume volume, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateVolumeOperationCallable()

  • updateVolumeCallable()

DeleteVolume

Deletes a single Volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteVolumeAsync(DeleteVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteVolumeAsync(VolumeName name)

  • deleteVolumeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteVolumeOperationCallable()

  • deleteVolumeCallable()

RevertVolume

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • revertVolumeAsync(RevertVolumeRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • revertVolumeOperationCallable()

  • revertVolumeCallable()

ListSnapshots

Returns descriptions of all snapshots for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSnapshots(ListSnapshotsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSnapshots(VolumeName parent)

  • listSnapshots(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSnapshotsPagedCallable()

  • listSnapshotsCallable()

GetSnapshot

Describe a snapshot for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSnapshot(GetSnapshotRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSnapshot(SnapshotName name)

  • getSnapshot(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSnapshotCallable()

CreateSnapshot

Create a new snapshot for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSnapshotAsync(CreateSnapshotRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createSnapshotAsync(VolumeName parent, Snapshot snapshot, String snapshotId)

  • createSnapshotAsync(String parent, Snapshot snapshot, String snapshotId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSnapshotOperationCallable()

  • createSnapshotCallable()

DeleteSnapshot

Deletes a snapshot.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSnapshotAsync(DeleteSnapshotRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteSnapshotAsync(SnapshotName name)

  • deleteSnapshotAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSnapshotOperationCallable()

  • deleteSnapshotCallable()

UpdateSnapshot

Updates the settings of a specific snapshot.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSnapshotAsync(UpdateSnapshotRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateSnapshotAsync(Snapshot snapshot, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSnapshotOperationCallable()

  • updateSnapshotCallable()

ListActiveDirectories

Lists active directories.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listActiveDirectories(ListActiveDirectoriesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listActiveDirectories(LocationName parent)

  • listActiveDirectories(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listActiveDirectoriesPagedCallable()

  • listActiveDirectoriesCallable()

GetActiveDirectory

Describes a specified active directory.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getActiveDirectory(GetActiveDirectoryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getActiveDirectory(ActiveDirectoryName name)

  • getActiveDirectory(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getActiveDirectoryCallable()

CreateActiveDirectory

CreateActiveDirectory Creates the active directory specified in the request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createActiveDirectoryAsync(CreateActiveDirectoryRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createActiveDirectoryAsync(LocationName parent, ActiveDirectory activeDirectory, String activeDirectoryId)

  • createActiveDirectoryAsync(String parent, ActiveDirectory activeDirectory, String activeDirectoryId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createActiveDirectoryOperationCallable()

  • createActiveDirectoryCallable()

UpdateActiveDirectory

Update the parameters of an active directories.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateActiveDirectoryAsync(UpdateActiveDirectoryRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateActiveDirectoryAsync(ActiveDirectory activeDirectory, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateActiveDirectoryOperationCallable()

  • updateActiveDirectoryCallable()

DeleteActiveDirectory

Delete the active directory specified in the request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteActiveDirectoryAsync(DeleteActiveDirectoryRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteActiveDirectoryAsync(ActiveDirectoryName name)

  • deleteActiveDirectoryAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteActiveDirectoryOperationCallable()

  • deleteActiveDirectoryCallable()

ListKmsConfigs

Returns descriptions of all KMS configs owned by the caller.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listKmsConfigs(ListKmsConfigsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listKmsConfigs(LocationName parent)

  • listKmsConfigs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listKmsConfigsPagedCallable()

  • listKmsConfigsCallable()

CreateKmsConfig

Creates a new KMS config.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createKmsConfigAsync(CreateKmsConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createKmsConfigAsync(LocationName parent, KmsConfig kmsConfig, String kmsConfigId)

  • createKmsConfigAsync(String parent, KmsConfig kmsConfig, String kmsConfigId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createKmsConfigOperationCallable()

  • createKmsConfigCallable()

GetKmsConfig

Returns the description of the specified KMS config by kms_config_id.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getKmsConfig(GetKmsConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getKmsConfig(KmsConfigName name)

  • getKmsConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getKmsConfigCallable()

UpdateKmsConfig

Updates the Kms config properties with the full spec

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateKmsConfigAsync(UpdateKmsConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateKmsConfigAsync(KmsConfig kmsConfig, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateKmsConfigOperationCallable()

  • updateKmsConfigCallable()

EncryptVolumes

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • encryptVolumesAsync(EncryptVolumesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • encryptVolumesOperationCallable()

  • encryptVolumesCallable()

VerifyKmsConfig

Verifies KMS config reachability.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • verifyKmsConfig(VerifyKmsConfigRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • verifyKmsConfigCallable()

DeleteKmsConfig

Warning! This operation will permanently delete the Kms config.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteKmsConfigAsync(DeleteKmsConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteKmsConfigAsync(KmsConfigName name)

  • deleteKmsConfigAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteKmsConfigOperationCallable()

  • deleteKmsConfigCallable()

ListReplications

Returns descriptions of all replications for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listReplications(ListReplicationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listReplications(VolumeName parent)

  • listReplications(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listReplicationsPagedCallable()

  • listReplicationsCallable()

GetReplication

Describe a replication for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getReplication(GetReplicationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getReplication(ReplicationName name)

  • getReplication(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getReplicationCallable()

CreateReplication

Create a new replication for a volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createReplicationAsync(CreateReplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createReplicationAsync(VolumeName parent, Replication replication, String replicationId)

  • createReplicationAsync(String parent, Replication replication, String replicationId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createReplicationOperationCallable()

  • createReplicationCallable()

DeleteReplication

Deletes a replication.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteReplicationAsync(DeleteReplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteReplicationAsync(ReplicationName name)

  • deleteReplicationAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteReplicationOperationCallable()

  • deleteReplicationCallable()

UpdateReplication

Updates the settings of a specific replication.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateReplicationAsync(UpdateReplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateReplicationAsync(Replication replication, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateReplicationOperationCallable()

  • updateReplicationCallable()

StopReplication

Stop Cross Region Replication.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • stopReplicationAsync(StopReplicationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • stopReplicationOperationCallable()

  • stopReplicationCallable()

ResumeReplication

Resume Cross Region Replication.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resumeReplicationAsync(ResumeReplicationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resumeReplicationOperationCallable()

  • resumeReplicationCallable()

ReverseReplicationDirection

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • reverseReplicationDirectionAsync(ReverseReplicationDirectionRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • reverseReplicationDirectionOperationCallable()

  • reverseReplicationDirectionCallable()

CreateBackupVault

Creates new backup vault

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createBackupVaultAsync(CreateBackupVaultRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createBackupVaultAsync(LocationName parent, BackupVault backupVault, String backupVaultId)

  • createBackupVaultAsync(String parent, BackupVault backupVault, String backupVaultId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createBackupVaultOperationCallable()

  • createBackupVaultCallable()

GetBackupVault

Returns the description of the specified backup vault

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getBackupVault(GetBackupVaultRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getBackupVault(BackupVaultName name)

  • getBackupVault(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getBackupVaultCallable()

ListBackupVaults

Returns list of all available backup vaults.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listBackupVaults(ListBackupVaultsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBackupVaults(LocationName parent)

  • listBackupVaults(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listBackupVaultsPagedCallable()

  • listBackupVaultsCallable()

UpdateBackupVault

Updates the settings of a specific backup vault.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateBackupVaultAsync(UpdateBackupVaultRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateBackupVaultAsync(BackupVault backupVault, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateBackupVaultOperationCallable()

  • updateBackupVaultCallable()

DeleteBackupVault

Warning! This operation will permanently delete the backup vault.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteBackupVaultAsync(DeleteBackupVaultRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteBackupVaultAsync(BackupVaultName name)

  • deleteBackupVaultAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteBackupVaultOperationCallable()

  • deleteBackupVaultCallable()

CreateBackup

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createBackupAsync(CreateBackupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createBackupAsync(BackupVaultName parent, Backup backup, String backupId)

  • createBackupAsync(String parent, Backup backup, String backupId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createBackupOperationCallable()

  • createBackupCallable()

GetBackup

Returns the description of the specified backup

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getBackup(GetBackupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getBackup(BackupName name)

  • getBackup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getBackupCallable()

ListBackups

Returns descriptions of all backups for a backupVault.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listBackups(ListBackupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBackups(BackupVaultName parent)

  • listBackups(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listBackupsPagedCallable()

  • listBackupsCallable()

DeleteBackup

Warning! This operation will permanently delete the backup.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteBackupAsync(DeleteBackupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteBackupAsync(BackupName name)

  • deleteBackupAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteBackupOperationCallable()

  • deleteBackupCallable()

UpdateBackup

Update backup with full spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateBackupAsync(UpdateBackupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateBackupAsync(Backup backup, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateBackupOperationCallable()

  • updateBackupCallable()

CreateBackupPolicy

Creates new backup policy

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createBackupPolicyAsync(CreateBackupPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createBackupPolicyAsync(LocationName parent, BackupPolicy backupPolicy, String backupPolicyId)

  • createBackupPolicyAsync(String parent, BackupPolicy backupPolicy, String backupPolicyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createBackupPolicyOperationCallable()

  • createBackupPolicyCallable()

GetBackupPolicy

Returns the description of the specified backup policy by backup_policy_id.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getBackupPolicy(GetBackupPolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getBackupPolicy(BackupPolicyName name)

  • getBackupPolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getBackupPolicyCallable()

ListBackupPolicies

Returns list of all available backup policies.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listBackupPolicies(ListBackupPoliciesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBackupPolicies(LocationName parent)

  • listBackupPolicies(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listBackupPoliciesPagedCallable()

  • listBackupPoliciesCallable()

UpdateBackupPolicy

Updates settings of a specific backup policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateBackupPolicyAsync(UpdateBackupPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateBackupPolicyAsync(BackupPolicy backupPolicy, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateBackupPolicyOperationCallable()

  • updateBackupPolicyCallable()

DeleteBackupPolicy

Warning! This operation will permanently delete the backup policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteBackupPolicyAsync(DeleteBackupPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteBackupPolicyAsync(BackupPolicyName name)

  • deleteBackupPolicyAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteBackupPolicyOperationCallable()

  • deleteBackupPolicyCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of NetAppSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NetAppSettings netAppSettings =
     NetAppSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NetAppClient netAppClient = NetAppClient.create(netAppSettings);
 

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NetAppSettings netAppSettings = NetAppSettings.newBuilder().setEndpoint(myEndpoint).build();
 NetAppClient netAppClient = NetAppClient.create(netAppSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NetAppSettings netAppSettings = NetAppSettings.newHttpJsonBuilder().build();
 NetAppClient netAppClient = NetAppClient.create(netAppSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > NetAppClient

Static Methods

create()

public static final NetAppClient create()

Constructs an instance of NetAppClient with default settings.

Returns
Type Description
NetAppClient
Exceptions
Type Description
IOException

create(NetAppSettings settings)

public static final NetAppClient create(NetAppSettings settings)

Constructs an instance of NetAppClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings NetAppSettings
Returns
Type Description
NetAppClient
Exceptions
Type Description
IOException

create(NetAppStub stub)

public static final NetAppClient create(NetAppStub stub)

Constructs an instance of NetAppClient, using the given stub for making calls. This is for advanced usage - prefer using create(NetAppSettings).

Parameter
Name Description
stub NetAppStub
Returns
Type Description
NetAppClient

Constructors

NetAppClient(NetAppSettings settings)

protected NetAppClient(NetAppSettings settings)

Constructs an instance of NetAppClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings NetAppSettings

NetAppClient(NetAppStub stub)

protected NetAppClient(NetAppStub stub)
Parameter
Name Description
stub NetAppStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createActiveDirectoryAsync(CreateActiveDirectoryRequest request)

public final OperationFuture<ActiveDirectory,OperationMetadata> createActiveDirectoryAsync(CreateActiveDirectoryRequest request)

CreateActiveDirectory Creates the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateActiveDirectoryRequest request =
       CreateActiveDirectoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .setActiveDirectoryId("activeDirectoryId589359490")
           .build();
   ActiveDirectory response = netAppClient.createActiveDirectoryAsync(request).get();
 }
 
Parameter
Name Description
request CreateActiveDirectoryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ActiveDirectory,OperationMetadata>

createActiveDirectoryAsync(LocationName parent, ActiveDirectory activeDirectory, String activeDirectoryId)

public final OperationFuture<ActiveDirectory,OperationMetadata> createActiveDirectoryAsync(LocationName parent, ActiveDirectory activeDirectory, String activeDirectoryId)

CreateActiveDirectory Creates the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ActiveDirectory activeDirectory = ActiveDirectory.newBuilder().build();
   String activeDirectoryId = "activeDirectoryId589359490";
   ActiveDirectory response =
       netAppClient.createActiveDirectoryAsync(parent, activeDirectory, activeDirectoryId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

activeDirectory ActiveDirectory

Required. Fields of the to be created active directory.

activeDirectoryId String

Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<ActiveDirectory,OperationMetadata>

createActiveDirectoryAsync(String parent, ActiveDirectory activeDirectory, String activeDirectoryId)

public final OperationFuture<ActiveDirectory,OperationMetadata> createActiveDirectoryAsync(String parent, ActiveDirectory activeDirectory, String activeDirectoryId)

CreateActiveDirectory Creates the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ActiveDirectory activeDirectory = ActiveDirectory.newBuilder().build();
   String activeDirectoryId = "activeDirectoryId589359490";
   ActiveDirectory response =
       netAppClient.createActiveDirectoryAsync(parent, activeDirectory, activeDirectoryId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

activeDirectory ActiveDirectory

Required. Fields of the to be created active directory.

activeDirectoryId String

Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<ActiveDirectory,OperationMetadata>

createActiveDirectoryCallable()

public final UnaryCallable<CreateActiveDirectoryRequest,Operation> createActiveDirectoryCallable()

CreateActiveDirectory Creates the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateActiveDirectoryRequest request =
       CreateActiveDirectoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .setActiveDirectoryId("activeDirectoryId589359490")
           .build();
   ApiFuture<Operation> future =
       netAppClient.createActiveDirectoryCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateActiveDirectoryRequest,Operation>

createActiveDirectoryOperationCallable()

public final OperationCallable<CreateActiveDirectoryRequest,ActiveDirectory,OperationMetadata> createActiveDirectoryOperationCallable()

CreateActiveDirectory Creates the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateActiveDirectoryRequest request =
       CreateActiveDirectoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .setActiveDirectoryId("activeDirectoryId589359490")
           .build();
   OperationFuture<ActiveDirectory, OperationMetadata> future =
       netAppClient.createActiveDirectoryOperationCallable().futureCall(request);
   // Do something.
   ActiveDirectory response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateActiveDirectoryRequest,ActiveDirectory,OperationMetadata>

createBackupAsync(BackupVaultName parent, Backup backup, String backupId)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(BackupVaultName parent, Backup backup, String backupId)

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.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupVaultName parent = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]");
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = netAppClient.createBackupAsync(parent, backup, backupId).get();
 }
 
Parameters
Name Description
parent BackupVaultName

Required. The NetApp backupVault to create the backups of, in the format projects/*/locations/*/backupVaults/{backup_vault_id}

backup Backup

Required. A backup resource

backupId String

Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Backup,OperationMetadata>

createBackupAsync(CreateBackupRequest request)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request)

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.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   Backup response = netAppClient.createBackupAsync(request).get();
 }
 
Parameter
Name Description
request CreateBackupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Backup,OperationMetadata>

createBackupAsync(String parent, Backup backup, String backupId)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId)

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.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString();
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = netAppClient.createBackupAsync(parent, backup, backupId).get();
 }
 
Parameters
Name Description
parent String

Required. The NetApp backupVault to create the backups of, in the format projects/*/locations/*/backupVaults/{backup_vault_id}

backup Backup

Required. A backup resource

backupId String

Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Backup,OperationMetadata>

createBackupCallable()

public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()

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.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.createBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateBackupRequest,Operation>

createBackupOperationCallable()

public final OperationCallable<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationCallable()

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.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   OperationFuture<Backup, OperationMetadata> future =
       netAppClient.createBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateBackupRequest,Backup,OperationMetadata>

createBackupPolicyAsync(CreateBackupPolicyRequest request)

public final OperationFuture<BackupPolicy,OperationMetadata> createBackupPolicyAsync(CreateBackupPolicyRequest request)

Creates new backup policy

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupPolicyRequest request =
       CreateBackupPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .setBackupPolicyId("backupPolicyId-1278533169")
           .build();
   BackupPolicy response = netAppClient.createBackupPolicyAsync(request).get();
 }
 
Parameter
Name Description
request CreateBackupPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<BackupPolicy,OperationMetadata>

createBackupPolicyAsync(LocationName parent, BackupPolicy backupPolicy, String backupPolicyId)

public final OperationFuture<BackupPolicy,OperationMetadata> createBackupPolicyAsync(LocationName parent, BackupPolicy backupPolicy, String backupPolicyId)

Creates new backup policy

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   BackupPolicy backupPolicy = BackupPolicy.newBuilder().build();
   String backupPolicyId = "backupPolicyId-1278533169";
   BackupPolicy response =
       netAppClient.createBackupPolicyAsync(parent, backupPolicy, backupPolicyId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The location to create the backup policies of, in the format projects/{project_id}/locations/{location}

backupPolicy BackupPolicy

Required. A backupPolicy resource

backupPolicyId String

Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<BackupPolicy,OperationMetadata>

createBackupPolicyAsync(String parent, BackupPolicy backupPolicy, String backupPolicyId)

public final OperationFuture<BackupPolicy,OperationMetadata> createBackupPolicyAsync(String parent, BackupPolicy backupPolicy, String backupPolicyId)

Creates new backup policy

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   BackupPolicy backupPolicy = BackupPolicy.newBuilder().build();
   String backupPolicyId = "backupPolicyId-1278533169";
   BackupPolicy response =
       netAppClient.createBackupPolicyAsync(parent, backupPolicy, backupPolicyId).get();
 }
 
Parameters
Name Description
parent String

Required. The location to create the backup policies of, in the format projects/{project_id}/locations/{location}

backupPolicy BackupPolicy

Required. A backupPolicy resource

backupPolicyId String

Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<BackupPolicy,OperationMetadata>

createBackupPolicyCallable()

public final UnaryCallable<CreateBackupPolicyRequest,Operation> createBackupPolicyCallable()

Creates new backup policy

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupPolicyRequest request =
       CreateBackupPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .setBackupPolicyId("backupPolicyId-1278533169")
           .build();
   ApiFuture<Operation> future = netAppClient.createBackupPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateBackupPolicyRequest,Operation>

createBackupPolicyOperationCallable()

public final OperationCallable<CreateBackupPolicyRequest,BackupPolicy,OperationMetadata> createBackupPolicyOperationCallable()

Creates new backup policy

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupPolicyRequest request =
       CreateBackupPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .setBackupPolicyId("backupPolicyId-1278533169")
           .build();
   OperationFuture<BackupPolicy, OperationMetadata> future =
       netAppClient.createBackupPolicyOperationCallable().futureCall(request);
   // Do something.
   BackupPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateBackupPolicyRequest,BackupPolicy,OperationMetadata>

createBackupVaultAsync(CreateBackupVaultRequest request)

public final OperationFuture<BackupVault,OperationMetadata> createBackupVaultAsync(CreateBackupVaultRequest request)

Creates new backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupVaultRequest request =
       CreateBackupVaultRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupVaultId("backupVaultId-1897432373")
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   BackupVault response = netAppClient.createBackupVaultAsync(request).get();
 }
 
Parameter
Name Description
request CreateBackupVaultRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<BackupVault,OperationMetadata>

createBackupVaultAsync(LocationName parent, BackupVault backupVault, String backupVaultId)

public final OperationFuture<BackupVault,OperationMetadata> createBackupVaultAsync(LocationName parent, BackupVault backupVault, String backupVaultId)

Creates new backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   BackupVault backupVault = BackupVault.newBuilder().build();
   String backupVaultId = "backupVaultId-1897432373";
   BackupVault response =
       netAppClient.createBackupVaultAsync(parent, backupVault, backupVaultId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The location to create the backup vaults, in the format projects/{project_id}/locations/{location}

backupVault BackupVault

Required. A backupVault resource

backupVaultId String

Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<BackupVault,OperationMetadata>

createBackupVaultAsync(String parent, BackupVault backupVault, String backupVaultId)

public final OperationFuture<BackupVault,OperationMetadata> createBackupVaultAsync(String parent, BackupVault backupVault, String backupVaultId)

Creates new backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   BackupVault backupVault = BackupVault.newBuilder().build();
   String backupVaultId = "backupVaultId-1897432373";
   BackupVault response =
       netAppClient.createBackupVaultAsync(parent, backupVault, backupVaultId).get();
 }
 
Parameters
Name Description
parent String

Required. The location to create the backup vaults, in the format projects/{project_id}/locations/{location}

backupVault BackupVault

Required. A backupVault resource

backupVaultId String

Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<BackupVault,OperationMetadata>

createBackupVaultCallable()

public final UnaryCallable<CreateBackupVaultRequest,Operation> createBackupVaultCallable()

Creates new backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupVaultRequest request =
       CreateBackupVaultRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupVaultId("backupVaultId-1897432373")
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.createBackupVaultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateBackupVaultRequest,Operation>

createBackupVaultOperationCallable()

public final OperationCallable<CreateBackupVaultRequest,BackupVault,OperationMetadata> createBackupVaultOperationCallable()

Creates new backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateBackupVaultRequest request =
       CreateBackupVaultRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupVaultId("backupVaultId-1897432373")
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   OperationFuture<BackupVault, OperationMetadata> future =
       netAppClient.createBackupVaultOperationCallable().futureCall(request);
   // Do something.
   BackupVault response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateBackupVaultRequest,BackupVault,OperationMetadata>

createKmsConfigAsync(CreateKmsConfigRequest request)

public final OperationFuture<KmsConfig,OperationMetadata> createKmsConfigAsync(CreateKmsConfigRequest request)

Creates a new KMS config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateKmsConfigRequest request =
       CreateKmsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKmsConfigId("kmsConfigId-1159731602")
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   KmsConfig response = netAppClient.createKmsConfigAsync(request).get();
 }
 
Parameter
Name Description
request CreateKmsConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

createKmsConfigAsync(LocationName parent, KmsConfig kmsConfig, String kmsConfigId)

public final OperationFuture<KmsConfig,OperationMetadata> createKmsConfigAsync(LocationName parent, KmsConfig kmsConfig, String kmsConfigId)

Creates a new KMS config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   KmsConfig kmsConfig = KmsConfig.newBuilder().build();
   String kmsConfigId = "kmsConfigId-1159731602";
   KmsConfig response = netAppClient.createKmsConfigAsync(parent, kmsConfig, kmsConfigId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

kmsConfig KmsConfig

Required. The required parameters to create a new KmsConfig.

kmsConfigId String

Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

createKmsConfigAsync(String parent, KmsConfig kmsConfig, String kmsConfigId)

public final OperationFuture<KmsConfig,OperationMetadata> createKmsConfigAsync(String parent, KmsConfig kmsConfig, String kmsConfigId)

Creates a new KMS config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   KmsConfig kmsConfig = KmsConfig.newBuilder().build();
   String kmsConfigId = "kmsConfigId-1159731602";
   KmsConfig response = netAppClient.createKmsConfigAsync(parent, kmsConfig, kmsConfigId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

kmsConfig KmsConfig

Required. The required parameters to create a new KmsConfig.

kmsConfigId String

Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

createKmsConfigCallable()

public final UnaryCallable<CreateKmsConfigRequest,Operation> createKmsConfigCallable()

Creates a new KMS config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateKmsConfigRequest request =
       CreateKmsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKmsConfigId("kmsConfigId-1159731602")
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.createKmsConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateKmsConfigRequest,Operation>

createKmsConfigOperationCallable()

public final OperationCallable<CreateKmsConfigRequest,KmsConfig,OperationMetadata> createKmsConfigOperationCallable()

Creates a new KMS config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateKmsConfigRequest request =
       CreateKmsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKmsConfigId("kmsConfigId-1159731602")
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   OperationFuture<KmsConfig, OperationMetadata> future =
       netAppClient.createKmsConfigOperationCallable().futureCall(request);
   // Do something.
   KmsConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateKmsConfigRequest,KmsConfig,OperationMetadata>

createReplicationAsync(CreateReplicationRequest request)

public final OperationFuture<Replication,OperationMetadata> createReplicationAsync(CreateReplicationRequest request)

Create a new replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateReplicationRequest request =
       CreateReplicationRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setReplication(Replication.newBuilder().build())
           .setReplicationId("replicationId1170820615")
           .build();
   Replication response = netAppClient.createReplicationAsync(request).get();
 }
 
Parameter
Name Description
request CreateReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

createReplicationAsync(VolumeName parent, Replication replication, String replicationId)

public final OperationFuture<Replication,OperationMetadata> createReplicationAsync(VolumeName parent, Replication replication, String replicationId)

Create a new replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   Replication replication = Replication.newBuilder().build();
   String replicationId = "replicationId1170820615";
   Replication response =
       netAppClient.createReplicationAsync(parent, replication, replicationId).get();
 }
 
Parameters
Name Description
parent VolumeName

Required. The NetApp volume to create the replications of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}

replication Replication

Required. A replication resource

replicationId String

Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

createReplicationAsync(String parent, Replication replication, String replicationId)

public final OperationFuture<Replication,OperationMetadata> createReplicationAsync(String parent, Replication replication, String replicationId)

Create a new replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   Replication replication = Replication.newBuilder().build();
   String replicationId = "replicationId1170820615";
   Replication response =
       netAppClient.createReplicationAsync(parent, replication, replicationId).get();
 }
 
Parameters
Name Description
parent String

Required. The NetApp volume to create the replications of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}

replication Replication

Required. A replication resource

replicationId String

Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

createReplicationCallable()

public final UnaryCallable<CreateReplicationRequest,Operation> createReplicationCallable()

Create a new replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateReplicationRequest request =
       CreateReplicationRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setReplication(Replication.newBuilder().build())
           .setReplicationId("replicationId1170820615")
           .build();
   ApiFuture<Operation> future = netAppClient.createReplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateReplicationRequest,Operation>

createReplicationOperationCallable()

public final OperationCallable<CreateReplicationRequest,Replication,OperationMetadata> createReplicationOperationCallable()

Create a new replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateReplicationRequest request =
       CreateReplicationRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setReplication(Replication.newBuilder().build())
           .setReplicationId("replicationId1170820615")
           .build();
   OperationFuture<Replication, OperationMetadata> future =
       netAppClient.createReplicationOperationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateReplicationRequest,Replication,OperationMetadata>

createSnapshotAsync(CreateSnapshotRequest request)

public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(CreateSnapshotRequest request)

Create a new snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateSnapshotRequest request =
       CreateSnapshotRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshot(Snapshot.newBuilder().build())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   Snapshot response = netAppClient.createSnapshotAsync(request).get();
 }
 
Parameter
Name Description
request CreateSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Snapshot,OperationMetadata>

createSnapshotAsync(VolumeName parent, Snapshot snapshot, String snapshotId)

public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(VolumeName parent, Snapshot snapshot, String snapshotId)

Create a new snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   Snapshot snapshot = Snapshot.newBuilder().build();
   String snapshotId = "snapshotId-1113817601";
   Snapshot response = netAppClient.createSnapshotAsync(parent, snapshot, snapshotId).get();
 }
 
Parameters
Name Description
parent VolumeName

Required. The NetApp volume to create the snapshots of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}

snapshot Snapshot

Required. A snapshot resource

snapshotId String

Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Snapshot,OperationMetadata>

createSnapshotAsync(String parent, Snapshot snapshot, String snapshotId)

public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(String parent, Snapshot snapshot, String snapshotId)

Create a new snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   Snapshot snapshot = Snapshot.newBuilder().build();
   String snapshotId = "snapshotId-1113817601";
   Snapshot response = netAppClient.createSnapshotAsync(parent, snapshot, snapshotId).get();
 }
 
Parameters
Name Description
parent String

Required. The NetApp volume to create the snapshots of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}

snapshot Snapshot

Required. A snapshot resource

snapshotId String

Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Snapshot,OperationMetadata>

createSnapshotCallable()

public final UnaryCallable<CreateSnapshotRequest,Operation> createSnapshotCallable()

Create a new snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateSnapshotRequest request =
       CreateSnapshotRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshot(Snapshot.newBuilder().build())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   ApiFuture<Operation> future = netAppClient.createSnapshotCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSnapshotRequest,Operation>

createSnapshotOperationCallable()

public final OperationCallable<CreateSnapshotRequest,Snapshot,OperationMetadata> createSnapshotOperationCallable()

Create a new snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateSnapshotRequest request =
       CreateSnapshotRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshot(Snapshot.newBuilder().build())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   OperationFuture<Snapshot, OperationMetadata> future =
       netAppClient.createSnapshotOperationCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateSnapshotRequest,Snapshot,OperationMetadata>

createStoragePoolAsync(CreateStoragePoolRequest request)

public final OperationFuture<StoragePool,OperationMetadata> createStoragePoolAsync(CreateStoragePoolRequest request)

Creates a new storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateStoragePoolRequest request =
       CreateStoragePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setStoragePoolId("storagePoolId1617506482")
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   StoragePool response = netAppClient.createStoragePoolAsync(request).get();
 }
 
Parameter
Name Description
request CreateStoragePoolRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

createStoragePoolAsync(LocationName parent, StoragePool storagePool, String storagePoolId)

public final OperationFuture<StoragePool,OperationMetadata> createStoragePoolAsync(LocationName parent, StoragePool storagePool, String storagePoolId)

Creates a new storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   StoragePool storagePool = StoragePool.newBuilder().build();
   String storagePoolId = "storagePoolId1617506482";
   StoragePool response =
       netAppClient.createStoragePoolAsync(parent, storagePool, storagePoolId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

storagePool StoragePool

Required. The required parameters to create a new storage pool.

storagePoolId String

Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

createStoragePoolAsync(String parent, StoragePool storagePool, String storagePoolId)

public final OperationFuture<StoragePool,OperationMetadata> createStoragePoolAsync(String parent, StoragePool storagePool, String storagePoolId)

Creates a new storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   StoragePool storagePool = StoragePool.newBuilder().build();
   String storagePoolId = "storagePoolId1617506482";
   StoragePool response =
       netAppClient.createStoragePoolAsync(parent, storagePool, storagePoolId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

storagePool StoragePool

Required. The required parameters to create a new storage pool.

storagePoolId String

Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

createStoragePoolCallable()

public final UnaryCallable<CreateStoragePoolRequest,Operation> createStoragePoolCallable()

Creates a new storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateStoragePoolRequest request =
       CreateStoragePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setStoragePoolId("storagePoolId1617506482")
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.createStoragePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateStoragePoolRequest,Operation>

createStoragePoolOperationCallable()

public final OperationCallable<CreateStoragePoolRequest,StoragePool,OperationMetadata> createStoragePoolOperationCallable()

Creates a new storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateStoragePoolRequest request =
       CreateStoragePoolRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setStoragePoolId("storagePoolId1617506482")
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   OperationFuture<StoragePool, OperationMetadata> future =
       netAppClient.createStoragePoolOperationCallable().futureCall(request);
   // Do something.
   StoragePool response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateStoragePoolRequest,StoragePool,OperationMetadata>

createVolumeAsync(CreateVolumeRequest request)

public final OperationFuture<Volume,OperationMetadata> createVolumeAsync(CreateVolumeRequest request)

Creates a new Volume in a given project and location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateVolumeRequest request =
       CreateVolumeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVolumeId("volumeId-1869770283")
           .setVolume(Volume.newBuilder().build())
           .build();
   Volume response = netAppClient.createVolumeAsync(request).get();
 }
 
Parameter
Name Description
request CreateVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

createVolumeAsync(LocationName parent, Volume volume, String volumeId)

public final OperationFuture<Volume,OperationMetadata> createVolumeAsync(LocationName parent, Volume volume, String volumeId)

Creates a new Volume in a given project and location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Volume volume = Volume.newBuilder().build();
   String volumeId = "volumeId-1869770283";
   Volume response = netAppClient.createVolumeAsync(parent, volume, volumeId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

volume Volume

Required. The volume being created.

volumeId String

Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

createVolumeAsync(String parent, Volume volume, String volumeId)

public final OperationFuture<Volume,OperationMetadata> createVolumeAsync(String parent, Volume volume, String volumeId)

Creates a new Volume in a given project and location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Volume volume = Volume.newBuilder().build();
   String volumeId = "volumeId-1869770283";
   Volume response = netAppClient.createVolumeAsync(parent, volume, volumeId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

volume Volume

Required. The volume being created.

volumeId String

Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

createVolumeCallable()

public final UnaryCallable<CreateVolumeRequest,Operation> createVolumeCallable()

Creates a new Volume in a given project and location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateVolumeRequest request =
       CreateVolumeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVolumeId("volumeId-1869770283")
           .setVolume(Volume.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.createVolumeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateVolumeRequest,Operation>

createVolumeOperationCallable()

public final OperationCallable<CreateVolumeRequest,Volume,OperationMetadata> createVolumeOperationCallable()

Creates a new Volume in a given project and location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   CreateVolumeRequest request =
       CreateVolumeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVolumeId("volumeId-1869770283")
           .setVolume(Volume.newBuilder().build())
           .build();
   OperationFuture<Volume, OperationMetadata> future =
       netAppClient.createVolumeOperationCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateVolumeRequest,Volume,OperationMetadata>

deleteActiveDirectoryAsync(ActiveDirectoryName name)

public final OperationFuture<Empty,OperationMetadata> deleteActiveDirectoryAsync(ActiveDirectoryName name)

Delete the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ActiveDirectoryName name =
       ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]");
   netAppClient.deleteActiveDirectoryAsync(name).get();
 }
 
Parameter
Name Description
name ActiveDirectoryName

Required. Name of the active directory.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteActiveDirectoryAsync(DeleteActiveDirectoryRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteActiveDirectoryAsync(DeleteActiveDirectoryRequest request)

Delete the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteActiveDirectoryRequest request =
       DeleteActiveDirectoryRequest.newBuilder()
           .setName(
               ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]")
                   .toString())
           .build();
   netAppClient.deleteActiveDirectoryAsync(request).get();
 }
 
Parameter
Name Description
request DeleteActiveDirectoryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteActiveDirectoryAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteActiveDirectoryAsync(String name)

Delete the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]").toString();
   netAppClient.deleteActiveDirectoryAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the active directory.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteActiveDirectoryCallable()

public final UnaryCallable<DeleteActiveDirectoryRequest,Operation> deleteActiveDirectoryCallable()

Delete the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteActiveDirectoryRequest request =
       DeleteActiveDirectoryRequest.newBuilder()
           .setName(
               ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       netAppClient.deleteActiveDirectoryCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteActiveDirectoryRequest,Operation>

deleteActiveDirectoryOperationCallable()

public final OperationCallable<DeleteActiveDirectoryRequest,Empty,OperationMetadata> deleteActiveDirectoryOperationCallable()

Delete the active directory specified in the request.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteActiveDirectoryRequest request =
       DeleteActiveDirectoryRequest.newBuilder()
           .setName(
               ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteActiveDirectoryOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteActiveDirectoryRequest,Empty,OperationMetadata>

deleteBackupAsync(BackupName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(BackupName name)

Warning! This operation will permanently delete the backup.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]");
   netAppClient.deleteBackupAsync(name).get();
 }
 
Parameter
Name Description
name BackupName

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupAsync(DeleteBackupRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)

Warning! This operation will permanently delete the backup.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString())
           .build();
   netAppClient.deleteBackupAsync(request).get();
 }
 
Parameter
Name Description
request DeleteBackupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)

Warning! This operation will permanently delete the backup.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString();
   netAppClient.deleteBackupAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupCallable()

public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()

Warning! This operation will permanently delete the backup.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteBackupCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteBackupRequest,Operation>

deleteBackupOperationCallable()

public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()

Warning! This operation will permanently delete the backup.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteBackupOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteBackupRequest,Empty,OperationMetadata>

deleteBackupPolicyAsync(BackupPolicyName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPolicyAsync(BackupPolicyName name)

Warning! This operation will permanently delete the backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupPolicyName name = BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]");
   netAppClient.deleteBackupPolicyAsync(name).get();
 }
 
Parameter
Name Description
name BackupPolicyName

Required. The backup policy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupPolicyAsync(DeleteBackupPolicyRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPolicyAsync(DeleteBackupPolicyRequest request)

Warning! This operation will permanently delete the backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupPolicyRequest request =
       DeleteBackupPolicyRequest.newBuilder()
           .setName(BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString())
           .build();
   netAppClient.deleteBackupPolicyAsync(request).get();
 }
 
Parameter
Name Description
request DeleteBackupPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupPolicyAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPolicyAsync(String name)

Warning! This operation will permanently delete the backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString();
   netAppClient.deleteBackupPolicyAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The backup policy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupPolicyCallable()

public final UnaryCallable<DeleteBackupPolicyRequest,Operation> deleteBackupPolicyCallable()

Warning! This operation will permanently delete the backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupPolicyRequest request =
       DeleteBackupPolicyRequest.newBuilder()
           .setName(BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteBackupPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteBackupPolicyRequest,Operation>

deleteBackupPolicyOperationCallable()

public final OperationCallable<DeleteBackupPolicyRequest,Empty,OperationMetadata> deleteBackupPolicyOperationCallable()

Warning! This operation will permanently delete the backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupPolicyRequest request =
       DeleteBackupPolicyRequest.newBuilder()
           .setName(BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteBackupPolicyOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteBackupPolicyRequest,Empty,OperationMetadata>

deleteBackupVaultAsync(BackupVaultName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupVaultAsync(BackupVaultName name)

Warning! This operation will permanently delete the backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupVaultName name = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]");
   netAppClient.deleteBackupVaultAsync(name).get();
 }
 
Parameter
Name Description
name BackupVaultName

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupVaultAsync(DeleteBackupVaultRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupVaultAsync(DeleteBackupVaultRequest request)

Warning! This operation will permanently delete the backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupVaultRequest request =
       DeleteBackupVaultRequest.newBuilder()
           .setName(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .build();
   netAppClient.deleteBackupVaultAsync(request).get();
 }
 
Parameter
Name Description
request DeleteBackupVaultRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupVaultAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupVaultAsync(String name)

Warning! This operation will permanently delete the backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString();
   netAppClient.deleteBackupVaultAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBackupVaultCallable()

public final UnaryCallable<DeleteBackupVaultRequest,Operation> deleteBackupVaultCallable()

Warning! This operation will permanently delete the backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupVaultRequest request =
       DeleteBackupVaultRequest.newBuilder()
           .setName(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteBackupVaultCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteBackupVaultRequest,Operation>

deleteBackupVaultOperationCallable()

public final OperationCallable<DeleteBackupVaultRequest,Empty,OperationMetadata> deleteBackupVaultOperationCallable()

Warning! This operation will permanently delete the backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteBackupVaultRequest request =
       DeleteBackupVaultRequest.newBuilder()
           .setName(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteBackupVaultOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteBackupVaultRequest,Empty,OperationMetadata>

deleteKmsConfigAsync(DeleteKmsConfigRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteKmsConfigAsync(DeleteKmsConfigRequest request)

Warning! This operation will permanently delete the Kms config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteKmsConfigRequest request =
       DeleteKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   netAppClient.deleteKmsConfigAsync(request).get();
 }
 
Parameter
Name Description
request DeleteKmsConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteKmsConfigAsync(KmsConfigName name)

public final OperationFuture<Empty,OperationMetadata> deleteKmsConfigAsync(KmsConfigName name)

Warning! This operation will permanently delete the Kms config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   KmsConfigName name = KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]");
   netAppClient.deleteKmsConfigAsync(name).get();
 }
 
Parameter
Name Description
name KmsConfigName

Required. Name of the KmsConfig.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteKmsConfigAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteKmsConfigAsync(String name)

Warning! This operation will permanently delete the Kms config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString();
   netAppClient.deleteKmsConfigAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the KmsConfig.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteKmsConfigCallable()

public final UnaryCallable<DeleteKmsConfigRequest,Operation> deleteKmsConfigCallable()

Warning! This operation will permanently delete the Kms config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteKmsConfigRequest request =
       DeleteKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteKmsConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteKmsConfigRequest,Operation>

deleteKmsConfigOperationCallable()

public final OperationCallable<DeleteKmsConfigRequest,Empty,OperationMetadata> deleteKmsConfigOperationCallable()

Warning! This operation will permanently delete the Kms config.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteKmsConfigRequest request =
       DeleteKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteKmsConfigOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteKmsConfigRequest,Empty,OperationMetadata>

deleteReplicationAsync(DeleteReplicationRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteReplicationAsync(DeleteReplicationRequest request)

Deletes a replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteReplicationRequest request =
       DeleteReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   netAppClient.deleteReplicationAsync(request).get();
 }
 
Parameter
Name Description
request DeleteReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteReplicationAsync(ReplicationName name)

public final OperationFuture<Empty,OperationMetadata> deleteReplicationAsync(ReplicationName name)

Deletes a replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ReplicationName name =
       ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]");
   netAppClient.deleteReplicationAsync(name).get();
 }
 
Parameter
Name Description
name ReplicationName

Required. The replication resource name, in the format projects/*/locations/*/volumes/*/replications/{replication_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteReplicationAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteReplicationAsync(String name)

Deletes a replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]").toString();
   netAppClient.deleteReplicationAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The replication resource name, in the format projects/*/locations/*/volumes/*/replications/{replication_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteReplicationCallable()

public final UnaryCallable<DeleteReplicationRequest,Operation> deleteReplicationCallable()

Deletes a replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteReplicationRequest request =
       DeleteReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteReplicationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteReplicationRequest,Operation>

deleteReplicationOperationCallable()

public final OperationCallable<DeleteReplicationRequest,Empty,OperationMetadata> deleteReplicationOperationCallable()

Deletes a replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteReplicationRequest request =
       DeleteReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteReplicationOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteReplicationRequest,Empty,OperationMetadata>

deleteSnapshotAsync(DeleteSnapshotRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSnapshotAsync(DeleteSnapshotRequest request)

Deletes a snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString())
           .build();
   netAppClient.deleteSnapshotAsync(request).get();
 }
 
Parameter
Name Description
request DeleteSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSnapshotAsync(SnapshotName name)

public final OperationFuture<Empty,OperationMetadata> deleteSnapshotAsync(SnapshotName name)

Deletes a snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]");
   netAppClient.deleteSnapshotAsync(name).get();
 }
 
Parameter
Name Description
name SnapshotName

Required. The snapshot resource name, in the format projects/*/locations/*/volumes/*/snapshots/{snapshot_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSnapshotAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSnapshotAsync(String name)

Deletes a snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString();
   netAppClient.deleteSnapshotAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The snapshot resource name, in the format projects/*/locations/*/volumes/*/snapshots/{snapshot_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSnapshotCallable()

public final UnaryCallable<DeleteSnapshotRequest,Operation> deleteSnapshotCallable()

Deletes a snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteSnapshotCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSnapshotRequest,Operation>

deleteSnapshotOperationCallable()

public final OperationCallable<DeleteSnapshotRequest,Empty,OperationMetadata> deleteSnapshotOperationCallable()

Deletes a snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteSnapshotOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteSnapshotRequest,Empty,OperationMetadata>

deleteStoragePoolAsync(DeleteStoragePoolRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteStoragePoolAsync(DeleteStoragePoolRequest request)

Warning! This operation will permanently delete the storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteStoragePoolRequest request =
       DeleteStoragePoolRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   netAppClient.deleteStoragePoolAsync(request).get();
 }
 
Parameter
Name Description
request DeleteStoragePoolRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteStoragePoolAsync(StoragePoolName name)

public final OperationFuture<Empty,OperationMetadata> deleteStoragePoolAsync(StoragePoolName name)

Warning! This operation will permanently delete the storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StoragePoolName name = StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]");
   netAppClient.deleteStoragePoolAsync(name).get();
 }
 
Parameter
Name Description
name StoragePoolName

Required. Name of the storage pool

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteStoragePoolAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteStoragePoolAsync(String name)

Warning! This operation will permanently delete the storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString();
   netAppClient.deleteStoragePoolAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the storage pool

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteStoragePoolCallable()

public final UnaryCallable<DeleteStoragePoolRequest,Operation> deleteStoragePoolCallable()

Warning! This operation will permanently delete the storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteStoragePoolRequest request =
       DeleteStoragePoolRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.deleteStoragePoolCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteStoragePoolRequest,Operation>

deleteStoragePoolOperationCallable()

public final OperationCallable<DeleteStoragePoolRequest,Empty,OperationMetadata> deleteStoragePoolOperationCallable()

Warning! This operation will permanently delete the storage pool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteStoragePoolRequest request =
       DeleteStoragePoolRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteStoragePoolOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteStoragePoolRequest,Empty,OperationMetadata>

deleteVolumeAsync(DeleteVolumeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteVolumeAsync(DeleteVolumeRequest request)

Deletes a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteVolumeRequest request =
       DeleteVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setForce(true)
           .build();
   netAppClient.deleteVolumeAsync(request).get();
 }
 
Parameter
Name Description
request DeleteVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVolumeAsync(VolumeName name)

public final OperationFuture<Empty,OperationMetadata> deleteVolumeAsync(VolumeName name)

Deletes a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   netAppClient.deleteVolumeAsync(name).get();
 }
 
Parameter
Name Description
name VolumeName

Required. Name of the volume

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVolumeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteVolumeAsync(String name)

Deletes a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   netAppClient.deleteVolumeAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the volume

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVolumeCallable()

public final UnaryCallable<DeleteVolumeRequest,Operation> deleteVolumeCallable()

Deletes a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteVolumeRequest request =
       DeleteVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future = netAppClient.deleteVolumeCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteVolumeRequest,Operation>

deleteVolumeOperationCallable()

public final OperationCallable<DeleteVolumeRequest,Empty,OperationMetadata> deleteVolumeOperationCallable()

Deletes a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   DeleteVolumeRequest request =
       DeleteVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       netAppClient.deleteVolumeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteVolumeRequest,Empty,OperationMetadata>

encryptVolumesAsync(EncryptVolumesRequest request)

public final OperationFuture<KmsConfig,OperationMetadata> encryptVolumesAsync(EncryptVolumesRequest request)

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   EncryptVolumesRequest request =
       EncryptVolumesRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   KmsConfig response = netAppClient.encryptVolumesAsync(request).get();
 }
 
Parameter
Name Description
request EncryptVolumesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

encryptVolumesCallable()

public final UnaryCallable<EncryptVolumesRequest,Operation> encryptVolumesCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   EncryptVolumesRequest request =
       EncryptVolumesRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   ApiFuture<Operation> future = netAppClient.encryptVolumesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<EncryptVolumesRequest,Operation>

encryptVolumesOperationCallable()

public final OperationCallable<EncryptVolumesRequest,KmsConfig,OperationMetadata> encryptVolumesOperationCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   EncryptVolumesRequest request =
       EncryptVolumesRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   OperationFuture<KmsConfig, OperationMetadata> future =
       netAppClient.encryptVolumesOperationCallable().futureCall(request);
   // Do something.
   KmsConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<EncryptVolumesRequest,KmsConfig,OperationMetadata>

getActiveDirectory(ActiveDirectoryName name)

public final ActiveDirectory getActiveDirectory(ActiveDirectoryName name)

Describes a specified active directory.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ActiveDirectoryName name =
       ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]");
   ActiveDirectory response = netAppClient.getActiveDirectory(name);
 }
 
Parameter
Name Description
name ActiveDirectoryName

Required. Name of the active directory.

Returns
Type Description
ActiveDirectory

getActiveDirectory(GetActiveDirectoryRequest request)

public final ActiveDirectory getActiveDirectory(GetActiveDirectoryRequest request)

Describes a specified active directory.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetActiveDirectoryRequest request =
       GetActiveDirectoryRequest.newBuilder()
           .setName(
               ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]")
                   .toString())
           .build();
   ActiveDirectory response = netAppClient.getActiveDirectory(request);
 }
 
Parameter
Name Description
request GetActiveDirectoryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ActiveDirectory

getActiveDirectory(String name)

public final ActiveDirectory getActiveDirectory(String name)

Describes a specified active directory.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]").toString();
   ActiveDirectory response = netAppClient.getActiveDirectory(name);
 }
 
Parameter
Name Description
name String

Required. Name of the active directory.

Returns
Type Description
ActiveDirectory

getActiveDirectoryCallable()

public final UnaryCallable<GetActiveDirectoryRequest,ActiveDirectory> getActiveDirectoryCallable()

Describes a specified active directory.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetActiveDirectoryRequest request =
       GetActiveDirectoryRequest.newBuilder()
           .setName(
               ActiveDirectoryName.of("[PROJECT]", "[LOCATION]", "[ACTIVE_DIRECTORY]")
                   .toString())
           .build();
   ApiFuture<ActiveDirectory> future =
       netAppClient.getActiveDirectoryCallable().futureCall(request);
   // Do something.
   ActiveDirectory response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetActiveDirectoryRequest,ActiveDirectory>

getBackup(BackupName name)

public final Backup getBackup(BackupName name)

Returns the description of the specified backup

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]");
   Backup response = netAppClient.getBackup(name);
 }
 
Parameter
Name Description
name BackupName

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Returns
Type Description
Backup

getBackup(GetBackupRequest request)

public final Backup getBackup(GetBackupRequest request)

Returns the description of the specified backup

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString())
           .build();
   Backup response = netAppClient.getBackup(request);
 }
 
Parameter
Name Description
request GetBackupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Backup

getBackup(String name)

public final Backup getBackup(String name)

Returns the description of the specified backup

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString();
   Backup response = netAppClient.getBackup(name);
 }
 
Parameter
Name Description
name String

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Returns
Type Description
Backup

getBackupCallable()

public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Returns the description of the specified backup

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]", "[BACKUP]").toString())
           .build();
   ApiFuture<Backup> future = netAppClient.getBackupCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetBackupRequest,Backup>

getBackupPolicy(BackupPolicyName name)

public final BackupPolicy getBackupPolicy(BackupPolicyName name)

Returns the description of the specified backup policy by backup_policy_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupPolicyName name = BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]");
   BackupPolicy response = netAppClient.getBackupPolicy(name);
 }
 
Parameter
Name Description
name BackupPolicyName

Required. The backupPolicy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Returns
Type Description
BackupPolicy

getBackupPolicy(GetBackupPolicyRequest request)

public final BackupPolicy getBackupPolicy(GetBackupPolicyRequest request)

Returns the description of the specified backup policy by backup_policy_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupPolicyRequest request =
       GetBackupPolicyRequest.newBuilder()
           .setName(BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString())
           .build();
   BackupPolicy response = netAppClient.getBackupPolicy(request);
 }
 
Parameter
Name Description
request GetBackupPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BackupPolicy

getBackupPolicy(String name)

public final BackupPolicy getBackupPolicy(String name)

Returns the description of the specified backup policy by backup_policy_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString();
   BackupPolicy response = netAppClient.getBackupPolicy(name);
 }
 
Parameter
Name Description
name String

Required. The backupPolicy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Returns
Type Description
BackupPolicy

getBackupPolicyCallable()

public final UnaryCallable<GetBackupPolicyRequest,BackupPolicy> getBackupPolicyCallable()

Returns the description of the specified backup policy by backup_policy_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupPolicyRequest request =
       GetBackupPolicyRequest.newBuilder()
           .setName(BackupPolicyName.of("[PROJECT]", "[LOCATION]", "[BACKUP_POLICY]").toString())
           .build();
   ApiFuture<BackupPolicy> future = netAppClient.getBackupPolicyCallable().futureCall(request);
   // Do something.
   BackupPolicy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetBackupPolicyRequest,BackupPolicy>

getBackupVault(BackupVaultName name)

public final BackupVault getBackupVault(BackupVaultName name)

Returns the description of the specified backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupVaultName name = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]");
   BackupVault response = netAppClient.getBackupVault(name);
 }
 
Parameter
Name Description
name BackupVaultName

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
BackupVault

getBackupVault(GetBackupVaultRequest request)

public final BackupVault getBackupVault(GetBackupVaultRequest request)

Returns the description of the specified backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupVaultRequest request =
       GetBackupVaultRequest.newBuilder()
           .setName(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .build();
   BackupVault response = netAppClient.getBackupVault(request);
 }
 
Parameter
Name Description
request GetBackupVaultRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BackupVault

getBackupVault(String name)

public final BackupVault getBackupVault(String name)

Returns the description of the specified backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString();
   BackupVault response = netAppClient.getBackupVault(name);
 }
 
Parameter
Name Description
name String

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
BackupVault

getBackupVaultCallable()

public final UnaryCallable<GetBackupVaultRequest,BackupVault> getBackupVaultCallable()

Returns the description of the specified backup vault

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetBackupVaultRequest request =
       GetBackupVaultRequest.newBuilder()
           .setName(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .build();
   ApiFuture<BackupVault> future = netAppClient.getBackupVaultCallable().futureCall(request);
   // Do something.
   BackupVault response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetBackupVaultRequest,BackupVault>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getKmsConfig(GetKmsConfigRequest request)

public final KmsConfig getKmsConfig(GetKmsConfigRequest request)

Returns the description of the specified KMS config by kms_config_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetKmsConfigRequest request =
       GetKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   KmsConfig response = netAppClient.getKmsConfig(request);
 }
 
Parameter
Name Description
request GetKmsConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
KmsConfig

getKmsConfig(KmsConfigName name)

public final KmsConfig getKmsConfig(KmsConfigName name)

Returns the description of the specified KMS config by kms_config_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   KmsConfigName name = KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]");
   KmsConfig response = netAppClient.getKmsConfig(name);
 }
 
Parameter
Name Description
name KmsConfigName

Required. Name of the KmsConfig

Returns
Type Description
KmsConfig

getKmsConfig(String name)

public final KmsConfig getKmsConfig(String name)

Returns the description of the specified KMS config by kms_config_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString();
   KmsConfig response = netAppClient.getKmsConfig(name);
 }
 
Parameter
Name Description
name String

Required. Name of the KmsConfig

Returns
Type Description
KmsConfig

getKmsConfigCallable()

public final UnaryCallable<GetKmsConfigRequest,KmsConfig> getKmsConfigCallable()

Returns the description of the specified KMS config by kms_config_id.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetKmsConfigRequest request =
       GetKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   ApiFuture<KmsConfig> future = netAppClient.getKmsConfigCallable().futureCall(request);
   // Do something.
   KmsConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetKmsConfigRequest,KmsConfig>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = netAppClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = netAppClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getReplication(GetReplicationRequest request)

public final Replication getReplication(GetReplicationRequest request)

Describe a replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetReplicationRequest request =
       GetReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   Replication response = netAppClient.getReplication(request);
 }
 
Parameter
Name Description
request GetReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Replication

getReplication(ReplicationName name)

public final Replication getReplication(ReplicationName name)

Describe a replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ReplicationName name =
       ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]");
   Replication response = netAppClient.getReplication(name);
 }
 
Parameter
Name Description
name ReplicationName

Required. The replication resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}

Returns
Type Description
Replication

getReplication(String name)

public final Replication getReplication(String name)

Describe a replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name =
       ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]").toString();
   Replication response = netAppClient.getReplication(name);
 }
 
Parameter
Name Description
name String

Required. The replication resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}

Returns
Type Description
Replication

getReplicationCallable()

public final UnaryCallable<GetReplicationRequest,Replication> getReplicationCallable()

Describe a replication for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetReplicationRequest request =
       GetReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   ApiFuture<Replication> future = netAppClient.getReplicationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetReplicationRequest,Replication>

getSettings()

public final NetAppSettings getSettings()
Returns
Type Description
NetAppSettings

getSnapshot(GetSnapshotRequest request)

public final Snapshot getSnapshot(GetSnapshotRequest request)

Describe a snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString())
           .build();
   Snapshot response = netAppClient.getSnapshot(request);
 }
 
Parameter
Name Description
request GetSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Snapshot

getSnapshot(SnapshotName name)

public final Snapshot getSnapshot(SnapshotName name)

Describe a snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]");
   Snapshot response = netAppClient.getSnapshot(name);
 }
 
Parameter
Name Description
name SnapshotName

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

Returns
Type Description
Snapshot

getSnapshot(String name)

public final Snapshot getSnapshot(String name)

Describe a snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString();
   Snapshot response = netAppClient.getSnapshot(name);
 }
 
Parameter
Name Description
name String

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

Returns
Type Description
Snapshot

getSnapshotCallable()

public final UnaryCallable<GetSnapshotRequest,Snapshot> getSnapshotCallable()

Describe a snapshot for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString())
           .build();
   ApiFuture<Snapshot> future = netAppClient.getSnapshotCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSnapshotRequest,Snapshot>

getStoragePool(GetStoragePoolRequest request)

public final StoragePool getStoragePool(GetStoragePoolRequest request)

Returns the description of the specified storage pool by poolId.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetStoragePoolRequest request =
       GetStoragePoolRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   StoragePool response = netAppClient.getStoragePool(request);
 }
 
Parameter
Name Description
request GetStoragePoolRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
StoragePool

getStoragePool(StoragePoolName name)

public final StoragePool getStoragePool(StoragePoolName name)

Returns the description of the specified storage pool by poolId.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StoragePoolName name = StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]");
   StoragePool response = netAppClient.getStoragePool(name);
 }
 
Parameter
Name Description
name StoragePoolName

Required. Name of the storage pool

Returns
Type Description
StoragePool

getStoragePool(String name)

public final StoragePool getStoragePool(String name)

Returns the description of the specified storage pool by poolId.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString();
   StoragePool response = netAppClient.getStoragePool(name);
 }
 
Parameter
Name Description
name String

Required. Name of the storage pool

Returns
Type Description
StoragePool

getStoragePoolCallable()

public final UnaryCallable<GetStoragePoolRequest,StoragePool> getStoragePoolCallable()

Returns the description of the specified storage pool by poolId.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetStoragePoolRequest request =
       GetStoragePoolRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   ApiFuture<StoragePool> future = netAppClient.getStoragePoolCallable().futureCall(request);
   // Do something.
   StoragePool response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetStoragePoolRequest,StoragePool>

getStub()

public NetAppStub getStub()
Returns
Type Description
NetAppStub

getVolume(GetVolumeRequest request)

public final Volume getVolume(GetVolumeRequest request)

Gets details of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetVolumeRequest request =
       GetVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   Volume response = netAppClient.getVolume(request);
 }
 
Parameter
Name Description
request GetVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Volume

getVolume(VolumeName name)

public final Volume getVolume(VolumeName name)

Gets details of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   Volume response = netAppClient.getVolume(name);
 }
 
Parameter
Name Description
name VolumeName

Required. Name of the volume

Returns
Type Description
Volume

getVolume(String name)

public final Volume getVolume(String name)

Gets details of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   Volume response = netAppClient.getVolume(name);
 }
 
Parameter
Name Description
name String

Required. Name of the volume

Returns
Type Description
Volume

getVolumeCallable()

public final UnaryCallable<GetVolumeRequest,Volume> getVolumeCallable()

Gets details of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   GetVolumeRequest request =
       GetVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   ApiFuture<Volume> future = netAppClient.getVolumeCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetVolumeRequest,Volume>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listActiveDirectories(ListActiveDirectoriesRequest request)

public final NetAppClient.ListActiveDirectoriesPagedResponse listActiveDirectories(ListActiveDirectoriesRequest request)

Lists active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListActiveDirectoriesRequest request =
       ListActiveDirectoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ActiveDirectory element : netAppClient.listActiveDirectories(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListActiveDirectoriesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListActiveDirectoriesPagedResponse

listActiveDirectories(LocationName parent)

public final NetAppClient.ListActiveDirectoriesPagedResponse listActiveDirectories(LocationName parent)

Lists active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ActiveDirectory element : netAppClient.listActiveDirectories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListActiveDirectoriesRequest

Returns
Type Description
NetAppClient.ListActiveDirectoriesPagedResponse

listActiveDirectories(String parent)

public final NetAppClient.ListActiveDirectoriesPagedResponse listActiveDirectories(String parent)

Lists active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ActiveDirectory element : netAppClient.listActiveDirectories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListActiveDirectoriesRequest

Returns
Type Description
NetAppClient.ListActiveDirectoriesPagedResponse

listActiveDirectoriesCallable()

public final UnaryCallable<ListActiveDirectoriesRequest,ListActiveDirectoriesResponse> listActiveDirectoriesCallable()

Lists active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListActiveDirectoriesRequest request =
       ListActiveDirectoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListActiveDirectoriesResponse response =
         netAppClient.listActiveDirectoriesCallable().call(request);
     for (ActiveDirectory element : response.getActiveDirectoriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListActiveDirectoriesRequest,ListActiveDirectoriesResponse>

listActiveDirectoriesPagedCallable()

public final UnaryCallable<ListActiveDirectoriesRequest,NetAppClient.ListActiveDirectoriesPagedResponse> listActiveDirectoriesPagedCallable()

Lists active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListActiveDirectoriesRequest request =
       ListActiveDirectoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ActiveDirectory> future =
       netAppClient.listActiveDirectoriesPagedCallable().futureCall(request);
   // Do something.
   for (ActiveDirectory element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListActiveDirectoriesRequest,ListActiveDirectoriesPagedResponse>

listBackupPolicies(ListBackupPoliciesRequest request)

public final NetAppClient.ListBackupPoliciesPagedResponse listBackupPolicies(ListBackupPoliciesRequest request)

Returns list of all available backup policies.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupPoliciesRequest request =
       ListBackupPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (BackupPolicy element : netAppClient.listBackupPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListBackupPoliciesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListBackupPoliciesPagedResponse

listBackupPolicies(LocationName parent)

public final NetAppClient.ListBackupPoliciesPagedResponse listBackupPolicies(LocationName parent)

Returns list of all available backup policies.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (BackupPolicy element : netAppClient.listBackupPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListBackupPoliciesRequest

Returns
Type Description
NetAppClient.ListBackupPoliciesPagedResponse

listBackupPolicies(String parent)

public final NetAppClient.ListBackupPoliciesPagedResponse listBackupPolicies(String parent)

Returns list of all available backup policies.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (BackupPolicy element : netAppClient.listBackupPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListBackupPoliciesRequest

Returns
Type Description
NetAppClient.ListBackupPoliciesPagedResponse

listBackupPoliciesCallable()

public final UnaryCallable<ListBackupPoliciesRequest,ListBackupPoliciesResponse> listBackupPoliciesCallable()

Returns list of all available backup policies.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupPoliciesRequest request =
       ListBackupPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListBackupPoliciesResponse response =
         netAppClient.listBackupPoliciesCallable().call(request);
     for (BackupPolicy element : response.getBackupPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupPoliciesRequest,ListBackupPoliciesResponse>

listBackupPoliciesPagedCallable()

public final UnaryCallable<ListBackupPoliciesRequest,NetAppClient.ListBackupPoliciesPagedResponse> listBackupPoliciesPagedCallable()

Returns list of all available backup policies.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupPoliciesRequest request =
       ListBackupPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<BackupPolicy> future =
       netAppClient.listBackupPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (BackupPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupPoliciesRequest,ListBackupPoliciesPagedResponse>

listBackupVaults(ListBackupVaultsRequest request)

public final NetAppClient.ListBackupVaultsPagedResponse listBackupVaults(ListBackupVaultsRequest request)

Returns list of all available backup vaults.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupVaultsRequest request =
       ListBackupVaultsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (BackupVault element : netAppClient.listBackupVaults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListBackupVaultsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListBackupVaultsPagedResponse

listBackupVaults(LocationName parent)

public final NetAppClient.ListBackupVaultsPagedResponse listBackupVaults(LocationName parent)

Returns list of all available backup vaults.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (BackupVault element : netAppClient.listBackupVaults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The location for which to retrieve backupVault information, in the format projects/{project_id}/locations/{location}.

Returns
Type Description
NetAppClient.ListBackupVaultsPagedResponse

listBackupVaults(String parent)

public final NetAppClient.ListBackupVaultsPagedResponse listBackupVaults(String parent)

Returns list of all available backup vaults.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (BackupVault element : netAppClient.listBackupVaults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The location for which to retrieve backupVault information, in the format projects/{project_id}/locations/{location}.

Returns
Type Description
NetAppClient.ListBackupVaultsPagedResponse

listBackupVaultsCallable()

public final UnaryCallable<ListBackupVaultsRequest,ListBackupVaultsResponse> listBackupVaultsCallable()

Returns list of all available backup vaults.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupVaultsRequest request =
       ListBackupVaultsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListBackupVaultsResponse response = netAppClient.listBackupVaultsCallable().call(request);
     for (BackupVault element : response.getBackupVaultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupVaultsRequest,ListBackupVaultsResponse>

listBackupVaultsPagedCallable()

public final UnaryCallable<ListBackupVaultsRequest,NetAppClient.ListBackupVaultsPagedResponse> listBackupVaultsPagedCallable()

Returns list of all available backup vaults.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupVaultsRequest request =
       ListBackupVaultsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<BackupVault> future =
       netAppClient.listBackupVaultsPagedCallable().futureCall(request);
   // Do something.
   for (BackupVault element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupVaultsRequest,ListBackupVaultsPagedResponse>

listBackups(BackupVaultName parent)

public final NetAppClient.ListBackupsPagedResponse listBackups(BackupVaultName parent)

Returns descriptions of all backups for a backupVault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupVaultName parent = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]");
   for (Backup element : netAppClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent BackupVaultName

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.

Returns
Type Description
NetAppClient.ListBackupsPagedResponse

listBackups(ListBackupsRequest request)

public final NetAppClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)

Returns descriptions of all backups for a backupVault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Backup element : netAppClient.listBackups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListBackupsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListBackupsPagedResponse

listBackups(String parent)

public final NetAppClient.ListBackupsPagedResponse listBackups(String parent)

Returns descriptions of all backups for a backupVault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString();
   for (Backup element : netAppClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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.

Returns
Type Description
NetAppClient.ListBackupsPagedResponse

listBackupsCallable()

public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Returns descriptions of all backups for a backupVault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListBackupsResponse response = netAppClient.listBackupsCallable().call(request);
     for (Backup element : response.getBackupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupsRequest,ListBackupsResponse>

listBackupsPagedCallable()

public final UnaryCallable<ListBackupsRequest,NetAppClient.ListBackupsPagedResponse> listBackupsPagedCallable()

Returns descriptions of all backups for a backupVault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupVaultName.of("[PROJECT]", "[LOCATION]", "[BACKUP_VAULT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Backup> future = netAppClient.listBackupsPagedCallable().futureCall(request);
   // Do something.
   for (Backup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse>

listKmsConfigs(ListKmsConfigsRequest request)

public final NetAppClient.ListKmsConfigsPagedResponse listKmsConfigs(ListKmsConfigsRequest request)

Returns descriptions of all KMS configs owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListKmsConfigsRequest request =
       ListKmsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (KmsConfig element : netAppClient.listKmsConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListKmsConfigsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListKmsConfigsPagedResponse

listKmsConfigs(LocationName parent)

public final NetAppClient.ListKmsConfigsPagedResponse listKmsConfigs(LocationName parent)

Returns descriptions of all KMS configs owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (KmsConfig element : netAppClient.listKmsConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value

Returns
Type Description
NetAppClient.ListKmsConfigsPagedResponse

listKmsConfigs(String parent)

public final NetAppClient.ListKmsConfigsPagedResponse listKmsConfigs(String parent)

Returns descriptions of all KMS configs owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (KmsConfig element : netAppClient.listKmsConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value

Returns
Type Description
NetAppClient.ListKmsConfigsPagedResponse

listKmsConfigsCallable()

public final UnaryCallable<ListKmsConfigsRequest,ListKmsConfigsResponse> listKmsConfigsCallable()

Returns descriptions of all KMS configs owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListKmsConfigsRequest request =
       ListKmsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListKmsConfigsResponse response = netAppClient.listKmsConfigsCallable().call(request);
     for (KmsConfig element : response.getKmsConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListKmsConfigsRequest,ListKmsConfigsResponse>

listKmsConfigsPagedCallable()

public final UnaryCallable<ListKmsConfigsRequest,NetAppClient.ListKmsConfigsPagedResponse> listKmsConfigsPagedCallable()

Returns descriptions of all KMS configs owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListKmsConfigsRequest request =
       ListKmsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<KmsConfig> future = netAppClient.listKmsConfigsPagedCallable().futureCall(request);
   // Do something.
   for (KmsConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListKmsConfigsRequest,ListKmsConfigsPagedResponse>

listLocations(ListLocationsRequest request)

public final NetAppClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : netAppClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = netAppClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,NetAppClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = netAppClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listReplications(ListReplicationsRequest request)

public final NetAppClient.ListReplicationsPagedResponse listReplications(ListReplicationsRequest request)

Returns descriptions of all replications for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListReplicationsRequest request =
       ListReplicationsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Replication element : netAppClient.listReplications(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListReplicationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListReplicationsPagedResponse

listReplications(VolumeName parent)

public final NetAppClient.ListReplicationsPagedResponse listReplications(VolumeName parent)

Returns descriptions of all replications for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   for (Replication element : netAppClient.listReplications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent VolumeName

Required. The volume for which to retrieve replication information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

Returns
Type Description
NetAppClient.ListReplicationsPagedResponse

listReplications(String parent)

public final NetAppClient.ListReplicationsPagedResponse listReplications(String parent)

Returns descriptions of all replications for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   for (Replication element : netAppClient.listReplications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The volume for which to retrieve replication information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

Returns
Type Description
NetAppClient.ListReplicationsPagedResponse

listReplicationsCallable()

public final UnaryCallable<ListReplicationsRequest,ListReplicationsResponse> listReplicationsCallable()

Returns descriptions of all replications for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListReplicationsRequest request =
       ListReplicationsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListReplicationsResponse response = netAppClient.listReplicationsCallable().call(request);
     for (Replication element : response.getReplicationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListReplicationsRequest,ListReplicationsResponse>

listReplicationsPagedCallable()

public final UnaryCallable<ListReplicationsRequest,NetAppClient.ListReplicationsPagedResponse> listReplicationsPagedCallable()

Returns descriptions of all replications for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListReplicationsRequest request =
       ListReplicationsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Replication> future =
       netAppClient.listReplicationsPagedCallable().futureCall(request);
   // Do something.
   for (Replication element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListReplicationsRequest,ListReplicationsPagedResponse>

listSnapshots(ListSnapshotsRequest request)

public final NetAppClient.ListSnapshotsPagedResponse listSnapshots(ListSnapshotsRequest request)

Returns descriptions of all snapshots for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Snapshot element : netAppClient.listSnapshots(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSnapshotsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListSnapshotsPagedResponse

listSnapshots(VolumeName parent)

public final NetAppClient.ListSnapshotsPagedResponse listSnapshots(VolumeName parent)

Returns descriptions of all snapshots for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   for (Snapshot element : netAppClient.listSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent VolumeName

Required. The volume for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

Returns
Type Description
NetAppClient.ListSnapshotsPagedResponse

listSnapshots(String parent)

public final NetAppClient.ListSnapshotsPagedResponse listSnapshots(String parent)

Returns descriptions of all snapshots for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   for (Snapshot element : netAppClient.listSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The volume for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

Returns
Type Description
NetAppClient.ListSnapshotsPagedResponse

listSnapshotsCallable()

public final UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse> listSnapshotsCallable()

Returns descriptions of all snapshots for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListSnapshotsResponse response = netAppClient.listSnapshotsCallable().call(request);
     for (Snapshot element : response.getSnapshotsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse>

listSnapshotsPagedCallable()

public final UnaryCallable<ListSnapshotsRequest,NetAppClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()

Returns descriptions of all snapshots for a volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Snapshot> future = netAppClient.listSnapshotsPagedCallable().futureCall(request);
   // Do something.
   for (Snapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSnapshotsRequest,ListSnapshotsPagedResponse>

listStoragePools(ListStoragePoolsRequest request)

public final NetAppClient.ListStoragePoolsPagedResponse listStoragePools(ListStoragePoolsRequest request)

Returns descriptions of all storage pools owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListStoragePoolsRequest request =
       ListStoragePoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (StoragePool element : netAppClient.listStoragePools(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListStoragePoolsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListStoragePoolsPagedResponse

listStoragePools(LocationName parent)

public final NetAppClient.ListStoragePoolsPagedResponse listStoragePools(LocationName parent)

Returns descriptions of all storage pools owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (StoragePool element : netAppClient.listStoragePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value

Returns
Type Description
NetAppClient.ListStoragePoolsPagedResponse

listStoragePools(String parent)

public final NetAppClient.ListStoragePoolsPagedResponse listStoragePools(String parent)

Returns descriptions of all storage pools owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (StoragePool element : netAppClient.listStoragePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value

Returns
Type Description
NetAppClient.ListStoragePoolsPagedResponse

listStoragePoolsCallable()

public final UnaryCallable<ListStoragePoolsRequest,ListStoragePoolsResponse> listStoragePoolsCallable()

Returns descriptions of all storage pools owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListStoragePoolsRequest request =
       ListStoragePoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListStoragePoolsResponse response = netAppClient.listStoragePoolsCallable().call(request);
     for (StoragePool element : response.getStoragePoolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListStoragePoolsRequest,ListStoragePoolsResponse>

listStoragePoolsPagedCallable()

public final UnaryCallable<ListStoragePoolsRequest,NetAppClient.ListStoragePoolsPagedResponse> listStoragePoolsPagedCallable()

Returns descriptions of all storage pools owned by the caller.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListStoragePoolsRequest request =
       ListStoragePoolsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<StoragePool> future =
       netAppClient.listStoragePoolsPagedCallable().futureCall(request);
   // Do something.
   for (StoragePool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListStoragePoolsRequest,ListStoragePoolsPagedResponse>

listVolumes(ListVolumesRequest request)

public final NetAppClient.ListVolumesPagedResponse listVolumes(ListVolumesRequest request)

Lists Volumes in a given project.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Volume element : netAppClient.listVolumes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListVolumesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetAppClient.ListVolumesPagedResponse

listVolumes(LocationName parent)

public final NetAppClient.ListVolumesPagedResponse listVolumes(LocationName parent)

Lists Volumes in a given project.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Volume element : netAppClient.listVolumes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListVolumesRequest

Returns
Type Description
NetAppClient.ListVolumesPagedResponse

listVolumes(String parent)

public final NetAppClient.ListVolumesPagedResponse listVolumes(String parent)

Lists Volumes in a given project.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Volume element : netAppClient.listVolumes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListVolumesRequest

Returns
Type Description
NetAppClient.ListVolumesPagedResponse

listVolumesCallable()

public final UnaryCallable<ListVolumesRequest,ListVolumesResponse> listVolumesCallable()

Lists Volumes in a given project.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVolumesResponse response = netAppClient.listVolumesCallable().call(request);
     for (Volume element : response.getVolumesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumesRequest,ListVolumesResponse>

listVolumesPagedCallable()

public final UnaryCallable<ListVolumesRequest,NetAppClient.ListVolumesPagedResponse> listVolumesPagedCallable()

Lists Volumes in a given project.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Volume> future = netAppClient.listVolumesPagedCallable().futureCall(request);
   // Do something.
   for (Volume element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumesRequest,ListVolumesPagedResponse>

resumeReplicationAsync(ResumeReplicationRequest request)

public final OperationFuture<Replication,OperationMetadata> resumeReplicationAsync(ResumeReplicationRequest request)

Resume Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ResumeReplicationRequest request =
       ResumeReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   Replication response = netAppClient.resumeReplicationAsync(request).get();
 }
 
Parameter
Name Description
request ResumeReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

resumeReplicationCallable()

public final UnaryCallable<ResumeReplicationRequest,Operation> resumeReplicationCallable()

Resume Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ResumeReplicationRequest request =
       ResumeReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   ApiFuture<Operation> future = netAppClient.resumeReplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ResumeReplicationRequest,Operation>

resumeReplicationOperationCallable()

public final OperationCallable<ResumeReplicationRequest,Replication,OperationMetadata> resumeReplicationOperationCallable()

Resume Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ResumeReplicationRequest request =
       ResumeReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   OperationFuture<Replication, OperationMetadata> future =
       netAppClient.resumeReplicationOperationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
OperationCallable<ResumeReplicationRequest,Replication,OperationMetadata>

reverseReplicationDirectionAsync(ReverseReplicationDirectionRequest request)

public final OperationFuture<Replication,OperationMetadata> reverseReplicationDirectionAsync(ReverseReplicationDirectionRequest request)

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ReverseReplicationDirectionRequest request =
       ReverseReplicationDirectionRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   Replication response = netAppClient.reverseReplicationDirectionAsync(request).get();
 }
 
Parameter
Name Description
request ReverseReplicationDirectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

reverseReplicationDirectionCallable()

public final UnaryCallable<ReverseReplicationDirectionRequest,Operation> reverseReplicationDirectionCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ReverseReplicationDirectionRequest request =
       ReverseReplicationDirectionRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       netAppClient.reverseReplicationDirectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ReverseReplicationDirectionRequest,Operation>

reverseReplicationDirectionOperationCallable()

public final OperationCallable<ReverseReplicationDirectionRequest,Replication,OperationMetadata> reverseReplicationDirectionOperationCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ReverseReplicationDirectionRequest request =
       ReverseReplicationDirectionRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .build();
   OperationFuture<Replication, OperationMetadata> future =
       netAppClient.reverseReplicationDirectionOperationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
OperationCallable<ReverseReplicationDirectionRequest,Replication,OperationMetadata>

revertVolumeAsync(RevertVolumeRequest request)

public final OperationFuture<Volume,OperationMetadata> revertVolumeAsync(RevertVolumeRequest request)

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   RevertVolumeRequest request =
       RevertVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   Volume response = netAppClient.revertVolumeAsync(request).get();
 }
 
Parameter
Name Description
request RevertVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

revertVolumeCallable()

public final UnaryCallable<RevertVolumeRequest,Operation> revertVolumeCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   RevertVolumeRequest request =
       RevertVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   ApiFuture<Operation> future = netAppClient.revertVolumeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RevertVolumeRequest,Operation>

revertVolumeOperationCallable()

public final OperationCallable<RevertVolumeRequest,Volume,OperationMetadata> revertVolumeOperationCallable()

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

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   RevertVolumeRequest request =
       RevertVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .build();
   OperationFuture<Volume, OperationMetadata> future =
       netAppClient.revertVolumeOperationCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
OperationCallable<RevertVolumeRequest,Volume,OperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

stopReplicationAsync(StopReplicationRequest request)

public final OperationFuture<Replication,OperationMetadata> stopReplicationAsync(StopReplicationRequest request)

Stop Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StopReplicationRequest request =
       StopReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .setForce(true)
           .build();
   Replication response = netAppClient.stopReplicationAsync(request).get();
 }
 
Parameter
Name Description
request StopReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

stopReplicationCallable()

public final UnaryCallable<StopReplicationRequest,Operation> stopReplicationCallable()

Stop Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StopReplicationRequest request =
       StopReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future = netAppClient.stopReplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<StopReplicationRequest,Operation>

stopReplicationOperationCallable()

public final OperationCallable<StopReplicationRequest,Replication,OperationMetadata> stopReplicationOperationCallable()

Stop Cross Region Replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StopReplicationRequest request =
       StopReplicationRequest.newBuilder()
           .setName(
               ReplicationName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[REPLICATION]")
                   .toString())
           .setForce(true)
           .build();
   OperationFuture<Replication, OperationMetadata> future =
       netAppClient.stopReplicationOperationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
OperationCallable<StopReplicationRequest,Replication,OperationMetadata>

switchActiveReplicaZoneAsync(SwitchActiveReplicaZoneRequest request)

public final OperationFuture<StoragePool,OperationMetadata> switchActiveReplicaZoneAsync(SwitchActiveReplicaZoneRequest request)

This operation will switch the active/replica zone for a regional storagePool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   SwitchActiveReplicaZoneRequest request =
       SwitchActiveReplicaZoneRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   StoragePool response = netAppClient.switchActiveReplicaZoneAsync(request).get();
 }
 
Parameter
Name Description
request SwitchActiveReplicaZoneRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

switchActiveReplicaZoneCallable()

public final UnaryCallable<SwitchActiveReplicaZoneRequest,Operation> switchActiveReplicaZoneCallable()

This operation will switch the active/replica zone for a regional storagePool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   SwitchActiveReplicaZoneRequest request =
       SwitchActiveReplicaZoneRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   ApiFuture<Operation> future =
       netAppClient.switchActiveReplicaZoneCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<SwitchActiveReplicaZoneRequest,Operation>

switchActiveReplicaZoneOperationCallable()

public final OperationCallable<SwitchActiveReplicaZoneRequest,StoragePool,OperationMetadata> switchActiveReplicaZoneOperationCallable()

This operation will switch the active/replica zone for a regional storagePool.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   SwitchActiveReplicaZoneRequest request =
       SwitchActiveReplicaZoneRequest.newBuilder()
           .setName(StoragePoolName.of("[PROJECT]", "[LOCATION]", "[STORAGE_POOL]").toString())
           .build();
   OperationFuture<StoragePool, OperationMetadata> future =
       netAppClient.switchActiveReplicaZoneOperationCallable().futureCall(request);
   // Do something.
   StoragePool response = future.get();
 }
 
Returns
Type Description
OperationCallable<SwitchActiveReplicaZoneRequest,StoragePool,OperationMetadata>

updateActiveDirectoryAsync(ActiveDirectory activeDirectory, FieldMask updateMask)

public final OperationFuture<ActiveDirectory,OperationMetadata> updateActiveDirectoryAsync(ActiveDirectory activeDirectory, FieldMask updateMask)

Update the parameters of an active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   ActiveDirectory activeDirectory = ActiveDirectory.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ActiveDirectory response =
       netAppClient.updateActiveDirectoryAsync(activeDirectory, updateMask).get();
 }
 
Parameters
Name Description
activeDirectory ActiveDirectory

Required. The volume being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<ActiveDirectory,OperationMetadata>

updateActiveDirectoryAsync(UpdateActiveDirectoryRequest request)

public final OperationFuture<ActiveDirectory,OperationMetadata> updateActiveDirectoryAsync(UpdateActiveDirectoryRequest request)

Update the parameters of an active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateActiveDirectoryRequest request =
       UpdateActiveDirectoryRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .build();
   ActiveDirectory response = netAppClient.updateActiveDirectoryAsync(request).get();
 }
 
Parameter
Name Description
request UpdateActiveDirectoryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ActiveDirectory,OperationMetadata>

updateActiveDirectoryCallable()

public final UnaryCallable<UpdateActiveDirectoryRequest,Operation> updateActiveDirectoryCallable()

Update the parameters of an active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateActiveDirectoryRequest request =
       UpdateActiveDirectoryRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       netAppClient.updateActiveDirectoryCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateActiveDirectoryRequest,Operation>

updateActiveDirectoryOperationCallable()

public final OperationCallable<UpdateActiveDirectoryRequest,ActiveDirectory,OperationMetadata> updateActiveDirectoryOperationCallable()

Update the parameters of an active directories.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateActiveDirectoryRequest request =
       UpdateActiveDirectoryRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setActiveDirectory(ActiveDirectory.newBuilder().build())
           .build();
   OperationFuture<ActiveDirectory, OperationMetadata> future =
       netAppClient.updateActiveDirectoryOperationCallable().futureCall(request);
   // Do something.
   ActiveDirectory response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateActiveDirectoryRequest,ActiveDirectory,OperationMetadata>

updateBackupAsync(Backup backup, FieldMask updateMask)

public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(Backup backup, FieldMask updateMask)

Update backup with full spec.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   Backup backup = Backup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Backup response = netAppClient.updateBackupAsync(backup, updateMask).get();
 }
 
Parameters
Name Description
backup Backup

Required. The backup being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<Backup,OperationMetadata>

updateBackupAsync(UpdateBackupRequest request)

public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(UpdateBackupRequest request)

Update backup with full spec.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackup(Backup.newBuilder().build())
           .build();
   Backup response = netAppClient.updateBackupAsync(request).get();
 }
 
Parameter
Name Description
request UpdateBackupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Backup,OperationMetadata>

updateBackupCallable()

public final UnaryCallable<UpdateBackupRequest,Operation> updateBackupCallable()

Update backup with full spec.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackup(Backup.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateBackupRequest,Operation>

updateBackupOperationCallable()

public final OperationCallable<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationCallable()

Update backup with full spec.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackup(Backup.newBuilder().build())
           .build();
   OperationFuture<Backup, OperationMetadata> future =
       netAppClient.updateBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateBackupRequest,Backup,OperationMetadata>

updateBackupPolicyAsync(BackupPolicy backupPolicy, FieldMask updateMask)

public final OperationFuture<BackupPolicy,OperationMetadata> updateBackupPolicyAsync(BackupPolicy backupPolicy, FieldMask updateMask)

Updates settings of a specific backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupPolicy backupPolicy = BackupPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BackupPolicy response = netAppClient.updateBackupPolicyAsync(backupPolicy, updateMask).get();
 }
 
Parameters
Name Description
backupPolicy BackupPolicy

Required. The backup policy being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<BackupPolicy,OperationMetadata>

updateBackupPolicyAsync(UpdateBackupPolicyRequest request)

public final OperationFuture<BackupPolicy,OperationMetadata> updateBackupPolicyAsync(UpdateBackupPolicyRequest request)

Updates settings of a specific backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupPolicyRequest request =
       UpdateBackupPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .build();
   BackupPolicy response = netAppClient.updateBackupPolicyAsync(request).get();
 }
 
Parameter
Name Description
request UpdateBackupPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<BackupPolicy,OperationMetadata>

updateBackupPolicyCallable()

public final UnaryCallable<UpdateBackupPolicyRequest,Operation> updateBackupPolicyCallable()

Updates settings of a specific backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupPolicyRequest request =
       UpdateBackupPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateBackupPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateBackupPolicyRequest,Operation>

updateBackupPolicyOperationCallable()

public final OperationCallable<UpdateBackupPolicyRequest,BackupPolicy,OperationMetadata> updateBackupPolicyOperationCallable()

Updates settings of a specific backup policy.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupPolicyRequest request =
       UpdateBackupPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupPolicy(BackupPolicy.newBuilder().build())
           .build();
   OperationFuture<BackupPolicy, OperationMetadata> future =
       netAppClient.updateBackupPolicyOperationCallable().futureCall(request);
   // Do something.
   BackupPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateBackupPolicyRequest,BackupPolicy,OperationMetadata>

updateBackupVaultAsync(BackupVault backupVault, FieldMask updateMask)

public final OperationFuture<BackupVault,OperationMetadata> updateBackupVaultAsync(BackupVault backupVault, FieldMask updateMask)

Updates the settings of a specific backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   BackupVault backupVault = BackupVault.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BackupVault response = netAppClient.updateBackupVaultAsync(backupVault, updateMask).get();
 }
 
Parameters
Name Description
backupVault BackupVault

Required. The backupVault being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<BackupVault,OperationMetadata>

updateBackupVaultAsync(UpdateBackupVaultRequest request)

public final OperationFuture<BackupVault,OperationMetadata> updateBackupVaultAsync(UpdateBackupVaultRequest request)

Updates the settings of a specific backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupVaultRequest request =
       UpdateBackupVaultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   BackupVault response = netAppClient.updateBackupVaultAsync(request).get();
 }
 
Parameter
Name Description
request UpdateBackupVaultRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<BackupVault,OperationMetadata>

updateBackupVaultCallable()

public final UnaryCallable<UpdateBackupVaultRequest,Operation> updateBackupVaultCallable()

Updates the settings of a specific backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupVaultRequest request =
       UpdateBackupVaultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateBackupVaultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateBackupVaultRequest,Operation>

updateBackupVaultOperationCallable()

public final OperationCallable<UpdateBackupVaultRequest,BackupVault,OperationMetadata> updateBackupVaultOperationCallable()

Updates the settings of a specific backup vault.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateBackupVaultRequest request =
       UpdateBackupVaultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBackupVault(BackupVault.newBuilder().build())
           .build();
   OperationFuture<BackupVault, OperationMetadata> future =
       netAppClient.updateBackupVaultOperationCallable().futureCall(request);
   // Do something.
   BackupVault response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateBackupVaultRequest,BackupVault,OperationMetadata>

updateKmsConfigAsync(KmsConfig kmsConfig, FieldMask updateMask)

public final OperationFuture<KmsConfig,OperationMetadata> updateKmsConfigAsync(KmsConfig kmsConfig, FieldMask updateMask)

Updates the Kms config properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   KmsConfig kmsConfig = KmsConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   KmsConfig response = netAppClient.updateKmsConfigAsync(kmsConfig, updateMask).get();
 }
 
Parameters
Name Description
kmsConfig KmsConfig

Required. The KmsConfig being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

updateKmsConfigAsync(UpdateKmsConfigRequest request)

public final OperationFuture<KmsConfig,OperationMetadata> updateKmsConfigAsync(UpdateKmsConfigRequest request)

Updates the Kms config properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateKmsConfigRequest request =
       UpdateKmsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   KmsConfig response = netAppClient.updateKmsConfigAsync(request).get();
 }
 
Parameter
Name Description
request UpdateKmsConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<KmsConfig,OperationMetadata>

updateKmsConfigCallable()

public final UnaryCallable<UpdateKmsConfigRequest,Operation> updateKmsConfigCallable()

Updates the Kms config properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateKmsConfigRequest request =
       UpdateKmsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateKmsConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateKmsConfigRequest,Operation>

updateKmsConfigOperationCallable()

public final OperationCallable<UpdateKmsConfigRequest,KmsConfig,OperationMetadata> updateKmsConfigOperationCallable()

Updates the Kms config properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateKmsConfigRequest request =
       UpdateKmsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setKmsConfig(KmsConfig.newBuilder().build())
           .build();
   OperationFuture<KmsConfig, OperationMetadata> future =
       netAppClient.updateKmsConfigOperationCallable().futureCall(request);
   // Do something.
   KmsConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateKmsConfigRequest,KmsConfig,OperationMetadata>

updateReplicationAsync(Replication replication, FieldMask updateMask)

public final OperationFuture<Replication,OperationMetadata> updateReplicationAsync(Replication replication, FieldMask updateMask)

Updates the settings of a specific replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   Replication replication = Replication.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Replication response = netAppClient.updateReplicationAsync(replication, updateMask).get();
 }
 
Parameters
Name Description
replication Replication

Required. A replication resource

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

updateReplicationAsync(UpdateReplicationRequest request)

public final OperationFuture<Replication,OperationMetadata> updateReplicationAsync(UpdateReplicationRequest request)

Updates the settings of a specific replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateReplicationRequest request =
       UpdateReplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setReplication(Replication.newBuilder().build())
           .build();
   Replication response = netAppClient.updateReplicationAsync(request).get();
 }
 
Parameter
Name Description
request UpdateReplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Replication,OperationMetadata>

updateReplicationCallable()

public final UnaryCallable<UpdateReplicationRequest,Operation> updateReplicationCallable()

Updates the settings of a specific replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateReplicationRequest request =
       UpdateReplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setReplication(Replication.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateReplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateReplicationRequest,Operation>

updateReplicationOperationCallable()

public final OperationCallable<UpdateReplicationRequest,Replication,OperationMetadata> updateReplicationOperationCallable()

Updates the settings of a specific replication.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateReplicationRequest request =
       UpdateReplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setReplication(Replication.newBuilder().build())
           .build();
   OperationFuture<Replication, OperationMetadata> future =
       netAppClient.updateReplicationOperationCallable().futureCall(request);
   // Do something.
   Replication response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateReplicationRequest,Replication,OperationMetadata>

updateSnapshotAsync(Snapshot snapshot, FieldMask updateMask)

public final OperationFuture<Snapshot,OperationMetadata> updateSnapshotAsync(Snapshot snapshot, FieldMask updateMask)

Updates the settings of a specific snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   Snapshot snapshot = Snapshot.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Snapshot response = netAppClient.updateSnapshotAsync(snapshot, updateMask).get();
 }
 
Parameters
Name Description
snapshot Snapshot

Required. A snapshot resource

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field.

Returns
Type Description
OperationFuture<Snapshot,OperationMetadata>

updateSnapshotAsync(UpdateSnapshotRequest request)

public final OperationFuture<Snapshot,OperationMetadata> updateSnapshotAsync(UpdateSnapshotRequest request)

Updates the settings of a specific snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateSnapshotRequest request =
       UpdateSnapshotRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSnapshot(Snapshot.newBuilder().build())
           .build();
   Snapshot response = netAppClient.updateSnapshotAsync(request).get();
 }
 
Parameter
Name Description
request UpdateSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Snapshot,OperationMetadata>

updateSnapshotCallable()

public final UnaryCallable<UpdateSnapshotRequest,Operation> updateSnapshotCallable()

Updates the settings of a specific snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateSnapshotRequest request =
       UpdateSnapshotRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSnapshot(Snapshot.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateSnapshotCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateSnapshotRequest,Operation>

updateSnapshotOperationCallable()

public final OperationCallable<UpdateSnapshotRequest,Snapshot,OperationMetadata> updateSnapshotOperationCallable()

Updates the settings of a specific snapshot.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateSnapshotRequest request =
       UpdateSnapshotRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSnapshot(Snapshot.newBuilder().build())
           .build();
   OperationFuture<Snapshot, OperationMetadata> future =
       netAppClient.updateSnapshotOperationCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateSnapshotRequest,Snapshot,OperationMetadata>

updateStoragePoolAsync(StoragePool storagePool, FieldMask updateMask)

public final OperationFuture<StoragePool,OperationMetadata> updateStoragePoolAsync(StoragePool storagePool, FieldMask updateMask)

Updates the storage pool properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   StoragePool storagePool = StoragePool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   StoragePool response = netAppClient.updateStoragePoolAsync(storagePool, updateMask).get();
 }
 
Parameters
Name Description
storagePool StoragePool

Required. The pool being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

updateStoragePoolAsync(UpdateStoragePoolRequest request)

public final OperationFuture<StoragePool,OperationMetadata> updateStoragePoolAsync(UpdateStoragePoolRequest request)

Updates the storage pool properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateStoragePoolRequest request =
       UpdateStoragePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   StoragePool response = netAppClient.updateStoragePoolAsync(request).get();
 }
 
Parameter
Name Description
request UpdateStoragePoolRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<StoragePool,OperationMetadata>

updateStoragePoolCallable()

public final UnaryCallable<UpdateStoragePoolRequest,Operation> updateStoragePoolCallable()

Updates the storage pool properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateStoragePoolRequest request =
       UpdateStoragePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateStoragePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateStoragePoolRequest,Operation>

updateStoragePoolOperationCallable()

public final OperationCallable<UpdateStoragePoolRequest,StoragePool,OperationMetadata> updateStoragePoolOperationCallable()

Updates the storage pool properties with the full spec

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateStoragePoolRequest request =
       UpdateStoragePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setStoragePool(StoragePool.newBuilder().build())
           .build();
   OperationFuture<StoragePool, OperationMetadata> future =
       netAppClient.updateStoragePoolOperationCallable().futureCall(request);
   // Do something.
   StoragePool response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateStoragePoolRequest,StoragePool,OperationMetadata>

updateVolumeAsync(UpdateVolumeRequest request)

public final OperationFuture<Volume,OperationMetadata> updateVolumeAsync(UpdateVolumeRequest request)

Updates the parameters of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVolume(Volume.newBuilder().build())
           .build();
   Volume response = netAppClient.updateVolumeAsync(request).get();
 }
 
Parameter
Name Description
request UpdateVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

updateVolumeAsync(Volume volume, FieldMask updateMask)

public final OperationFuture<Volume,OperationMetadata> updateVolumeAsync(Volume volume, FieldMask updateMask)

Updates the parameters of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   Volume volume = Volume.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Volume response = netAppClient.updateVolumeAsync(volume, updateMask).get();
 }
 
Parameters
Name Description
volume Volume

Required. The volume being updated

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

updateVolumeCallable()

public final UnaryCallable<UpdateVolumeRequest,Operation> updateVolumeCallable()

Updates the parameters of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVolume(Volume.newBuilder().build())
           .build();
   ApiFuture<Operation> future = netAppClient.updateVolumeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateVolumeRequest,Operation>

updateVolumeOperationCallable()

public final OperationCallable<UpdateVolumeRequest,Volume,OperationMetadata> updateVolumeOperationCallable()

Updates the parameters of a single Volume.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVolume(Volume.newBuilder().build())
           .build();
   OperationFuture<Volume, OperationMetadata> future =
       netAppClient.updateVolumeOperationCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateVolumeRequest,Volume,OperationMetadata>

verifyKmsConfig(VerifyKmsConfigRequest request)

public final VerifyKmsConfigResponse verifyKmsConfig(VerifyKmsConfigRequest request)

Verifies KMS config reachability.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VerifyKmsConfigRequest request =
       VerifyKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   VerifyKmsConfigResponse response = netAppClient.verifyKmsConfig(request);
 }
 
Parameter
Name Description
request VerifyKmsConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VerifyKmsConfigResponse

verifyKmsConfigCallable()

public final UnaryCallable<VerifyKmsConfigRequest,VerifyKmsConfigResponse> verifyKmsConfigCallable()

Verifies KMS config reachability.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NetAppClient netAppClient = NetAppClient.create()) {
   VerifyKmsConfigRequest request =
       VerifyKmsConfigRequest.newBuilder()
           .setName(KmsConfigName.of("[PROJECT]", "[LOCATION]", "[KMS_CONFIG]").toString())
           .build();
   ApiFuture<VerifyKmsConfigResponse> future =
       netAppClient.verifyKmsConfigCallable().futureCall(request);
   // Do something.
   VerifyKmsConfigResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<VerifyKmsConfigRequest,VerifyKmsConfigResponse>