NetApp v1 API - Class NetApp.NetAppBase (1.6.0)

[BindServiceMethod(typeof(NetApp), "BindService")]
public abstract class NetApp.NetAppBase

Reference documentation and code samples for the NetApp v1 API class NetApp.NetAppBase.

Base class for server-side implementations of NetApp

Inheritance

object > NetApp.NetAppBase

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Methods

CreateActiveDirectory(CreateActiveDirectoryRequest, ServerCallContext)

public virtual Task<Operation> CreateActiveDirectory(CreateActiveDirectoryRequest request, ServerCallContext context)

CreateActiveDirectory Creates the active directory specified in the request.

Parameters
Name Description
request CreateActiveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateBackup(CreateBackupRequest, ServerCallContext)

public virtual Task<Operation> CreateBackup(CreateBackupRequest request, ServerCallContext context)

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

Parameters
Name Description
request CreateBackupRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateBackupPolicy(CreateBackupPolicyRequest, ServerCallContext)

public virtual Task<Operation> CreateBackupPolicy(CreateBackupPolicyRequest request, ServerCallContext context)

Creates new backup policy

Parameters
Name Description
request CreateBackupPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateBackupVault(CreateBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> CreateBackupVault(CreateBackupVaultRequest request, ServerCallContext context)

Creates new backup vault

Parameters
Name Description
request CreateBackupVaultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateKmsConfig(CreateKmsConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateKmsConfig(CreateKmsConfigRequest request, ServerCallContext context)

Creates a new KMS config.

Parameters
Name Description
request CreateKmsConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateReplication(CreateReplicationRequest, ServerCallContext)

public virtual Task<Operation> CreateReplication(CreateReplicationRequest request, ServerCallContext context)

Create a new replication for a volume.

Parameters
Name Description
request CreateReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateSnapshot(CreateSnapshotRequest, ServerCallContext)

public virtual Task<Operation> CreateSnapshot(CreateSnapshotRequest request, ServerCallContext context)

Create a new snapshot for a volume.

Parameters
Name Description
request CreateSnapshotRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateStoragePool(CreateStoragePoolRequest, ServerCallContext)

public virtual Task<Operation> CreateStoragePool(CreateStoragePoolRequest request, ServerCallContext context)

Creates a new storage pool.

Parameters
Name Description
request CreateStoragePoolRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateVolume(CreateVolumeRequest, ServerCallContext)

public virtual Task<Operation> CreateVolume(CreateVolumeRequest request, ServerCallContext context)

Creates a new Volume in a given project and location.

Parameters
Name Description
request CreateVolumeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteActiveDirectory(DeleteActiveDirectoryRequest, ServerCallContext)

public virtual Task<Operation> DeleteActiveDirectory(DeleteActiveDirectoryRequest request, ServerCallContext context)

Delete the active directory specified in the request.

Parameters
Name Description
request DeleteActiveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Warning! This operation will permanently delete the backup.

Parameters
Name Description
request DeleteBackupRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteBackupPolicy(DeleteBackupPolicyRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackupPolicy(DeleteBackupPolicyRequest request, ServerCallContext context)

Warning! This operation will permanently delete the backup policy.

Parameters
Name Description
request DeleteBackupPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteBackupVault(DeleteBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackupVault(DeleteBackupVaultRequest request, ServerCallContext context)

Warning! This operation will permanently delete the backup vault.

Parameters
Name Description
request DeleteBackupVaultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteKmsConfig(DeleteKmsConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteKmsConfig(DeleteKmsConfigRequest request, ServerCallContext context)

Warning! This operation will permanently delete the Kms config.

Parameters
Name Description
request DeleteKmsConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteReplication(DeleteReplicationRequest, ServerCallContext)

public virtual Task<Operation> DeleteReplication(DeleteReplicationRequest request, ServerCallContext context)

Deletes a replication.

Parameters
Name Description
request DeleteReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteSnapshot(DeleteSnapshotRequest, ServerCallContext)

public virtual Task<Operation> DeleteSnapshot(DeleteSnapshotRequest request, ServerCallContext context)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteStoragePool(DeleteStoragePoolRequest, ServerCallContext)

public virtual Task<Operation> DeleteStoragePool(DeleteStoragePoolRequest request, ServerCallContext context)

Warning! This operation will permanently delete the storage pool.

Parameters
Name Description
request DeleteStoragePoolRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteVolume(DeleteVolumeRequest, ServerCallContext)

public virtual Task<Operation> DeleteVolume(DeleteVolumeRequest request, ServerCallContext context)

Deletes a single Volume.

Parameters
Name Description
request DeleteVolumeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

EncryptVolumes(EncryptVolumesRequest, ServerCallContext)

public virtual Task<Operation> EncryptVolumes(EncryptVolumesRequest request, ServerCallContext context)

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

Parameters
Name Description
request EncryptVolumesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

EstablishPeering(EstablishPeeringRequest, ServerCallContext)

public virtual Task<Operation> EstablishPeering(EstablishPeeringRequest request, ServerCallContext context)

Establish replication peering.

Parameters
Name Description
request EstablishPeeringRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetActiveDirectory(GetActiveDirectoryRequest, ServerCallContext)

public virtual Task<ActiveDirectory> GetActiveDirectory(GetActiveDirectoryRequest request, ServerCallContext context)

Describes a specified active directory.

Parameters
Name Description
request GetActiveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskActiveDirectory

The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Returns the description of the specified backup

Parameters
Name Description
request GetBackupRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskBackup

The response to send back to the client (wrapped by a task).

GetBackupPolicy(GetBackupPolicyRequest, ServerCallContext)

public virtual Task<BackupPolicy> GetBackupPolicy(GetBackupPolicyRequest request, ServerCallContext context)

Returns the description of the specified backup policy by backup_policy_id.

Parameters
Name Description
request GetBackupPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskBackupPolicy

The response to send back to the client (wrapped by a task).

GetBackupVault(GetBackupVaultRequest, ServerCallContext)

public virtual Task<BackupVault> GetBackupVault(GetBackupVaultRequest request, ServerCallContext context)

Returns the description of the specified backup vault

Parameters
Name Description
request GetBackupVaultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskBackupVault

The response to send back to the client (wrapped by a task).

GetKmsConfig(GetKmsConfigRequest, ServerCallContext)

public virtual Task<KmsConfig> GetKmsConfig(GetKmsConfigRequest request, ServerCallContext context)

Returns the description of the specified KMS config by kms_config_id.

Parameters
Name Description
request GetKmsConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskKmsConfig

The response to send back to the client (wrapped by a task).

GetReplication(GetReplicationRequest, ServerCallContext)

public virtual Task<Replication> GetReplication(GetReplicationRequest request, ServerCallContext context)

Describe a replication for a volume.

Parameters
Name Description
request GetReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReplication

The response to send back to the client (wrapped by a task).

GetSnapshot(GetSnapshotRequest, ServerCallContext)

public virtual Task<Snapshot> GetSnapshot(GetSnapshotRequest request, ServerCallContext context)

Describe a snapshot for a volume.

Parameters
Name Description
request GetSnapshotRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSnapshot

The response to send back to the client (wrapped by a task).

GetStoragePool(GetStoragePoolRequest, ServerCallContext)

public virtual Task<StoragePool> GetStoragePool(GetStoragePoolRequest request, ServerCallContext context)

Returns the description of the specified storage pool by poolId.

Parameters
Name Description
request GetStoragePoolRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskStoragePool

The response to send back to the client (wrapped by a task).

GetVolume(GetVolumeRequest, ServerCallContext)

public virtual Task<Volume> GetVolume(GetVolumeRequest request, ServerCallContext context)

Gets details of a single Volume.

Parameters
Name Description
request GetVolumeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVolume

The response to send back to the client (wrapped by a task).

ListActiveDirectories(ListActiveDirectoriesRequest, ServerCallContext)

public virtual Task<ListActiveDirectoriesResponse> ListActiveDirectories(ListActiveDirectoriesRequest request, ServerCallContext context)

Lists active directories.

Parameters
Name Description
request ListActiveDirectoriesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListActiveDirectoriesResponse

The response to send back to the client (wrapped by a task).

ListBackupPolicies(ListBackupPoliciesRequest, ServerCallContext)

public virtual Task<ListBackupPoliciesResponse> ListBackupPolicies(ListBackupPoliciesRequest request, ServerCallContext context)

Returns list of all available backup policies.

Parameters
Name Description
request ListBackupPoliciesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListBackupPoliciesResponse

The response to send back to the client (wrapped by a task).

ListBackupVaults(ListBackupVaultsRequest, ServerCallContext)

public virtual Task<ListBackupVaultsResponse> ListBackupVaults(ListBackupVaultsRequest request, ServerCallContext context)

Returns list of all available backup vaults.

Parameters
Name Description
request ListBackupVaultsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListBackupVaultsResponse

The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

Returns descriptions of all backups for a backupVault.

Parameters
Name Description
request ListBackupsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListBackupsResponse

The response to send back to the client (wrapped by a task).

ListKmsConfigs(ListKmsConfigsRequest, ServerCallContext)

public virtual Task<ListKmsConfigsResponse> ListKmsConfigs(ListKmsConfigsRequest request, ServerCallContext context)

Returns descriptions of all KMS configs owned by the caller.

Parameters
Name Description
request ListKmsConfigsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListKmsConfigsResponse

The response to send back to the client (wrapped by a task).

ListReplications(ListReplicationsRequest, ServerCallContext)

public virtual Task<ListReplicationsResponse> ListReplications(ListReplicationsRequest request, ServerCallContext context)

Returns descriptions of all replications for a volume.

Parameters
Name Description
request ListReplicationsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListReplicationsResponse

The response to send back to the client (wrapped by a task).

ListSnapshots(ListSnapshotsRequest, ServerCallContext)

public virtual Task<ListSnapshotsResponse> ListSnapshots(ListSnapshotsRequest request, ServerCallContext context)

Returns descriptions of all snapshots for a volume.

Parameters
Name Description
request ListSnapshotsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListSnapshotsResponse

The response to send back to the client (wrapped by a task).

ListStoragePools(ListStoragePoolsRequest, ServerCallContext)

public virtual Task<ListStoragePoolsResponse> ListStoragePools(ListStoragePoolsRequest request, ServerCallContext context)

Returns descriptions of all storage pools owned by the caller.

Parameters
Name Description
request ListStoragePoolsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListStoragePoolsResponse

The response to send back to the client (wrapped by a task).

ListVolumes(ListVolumesRequest, ServerCallContext)

public virtual Task<ListVolumesResponse> ListVolumes(ListVolumesRequest request, ServerCallContext context)

Lists Volumes in a given project.

Parameters
Name Description
request ListVolumesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListVolumesResponse

The response to send back to the client (wrapped by a task).

ResumeReplication(ResumeReplicationRequest, ServerCallContext)

public virtual Task<Operation> ResumeReplication(ResumeReplicationRequest request, ServerCallContext context)

Resume Cross Region Replication.

Parameters
Name Description
request ResumeReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ReverseReplicationDirection(ReverseReplicationDirectionRequest, ServerCallContext)

public virtual Task<Operation> ReverseReplicationDirection(ReverseReplicationDirectionRequest request, ServerCallContext context)

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

Parameters
Name Description
request ReverseReplicationDirectionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

RevertVolume(RevertVolumeRequest, ServerCallContext)

public virtual Task<Operation> RevertVolume(RevertVolumeRequest request, ServerCallContext context)

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

Parameters
Name Description
request RevertVolumeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

StopReplication(StopReplicationRequest, ServerCallContext)

public virtual Task<Operation> StopReplication(StopReplicationRequest request, ServerCallContext context)

Stop Cross Region Replication.

Parameters
Name Description
request StopReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

SwitchActiveReplicaZone(SwitchActiveReplicaZoneRequest, ServerCallContext)

public virtual Task<Operation> SwitchActiveReplicaZone(SwitchActiveReplicaZoneRequest request, ServerCallContext context)

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

Parameters
Name Description
request SwitchActiveReplicaZoneRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

SyncReplication(SyncReplicationRequest, ServerCallContext)

public virtual Task<Operation> SyncReplication(SyncReplicationRequest request, ServerCallContext context)

Syncs the replication. This will invoke one time volume data transfer from source to destination.

Parameters
Name Description
request SyncReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateActiveDirectory(UpdateActiveDirectoryRequest, ServerCallContext)

public virtual Task<Operation> UpdateActiveDirectory(UpdateActiveDirectoryRequest request, ServerCallContext context)

Update the parameters of an active directories.

Parameters
Name Description
request UpdateActiveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateBackup(UpdateBackupRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackup(UpdateBackupRequest request, ServerCallContext context)

Update backup with full spec.

Parameters
Name Description
request UpdateBackupRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateBackupPolicy(UpdateBackupPolicyRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackupPolicy(UpdateBackupPolicyRequest request, ServerCallContext context)

Updates settings of a specific backup policy.

Parameters
Name Description
request UpdateBackupPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateBackupVault(UpdateBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackupVault(UpdateBackupVaultRequest request, ServerCallContext context)

Updates the settings of a specific backup vault.

Parameters
Name Description
request UpdateBackupVaultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateKmsConfig(UpdateKmsConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateKmsConfig(UpdateKmsConfigRequest request, ServerCallContext context)

Updates the Kms config properties with the full spec

Parameters
Name Description
request UpdateKmsConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateReplication(UpdateReplicationRequest, ServerCallContext)

public virtual Task<Operation> UpdateReplication(UpdateReplicationRequest request, ServerCallContext context)

Updates the settings of a specific replication.

Parameters
Name Description
request UpdateReplicationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateSnapshot(UpdateSnapshotRequest, ServerCallContext)

public virtual Task<Operation> UpdateSnapshot(UpdateSnapshotRequest request, ServerCallContext context)

Updates the settings of a specific snapshot.

Parameters
Name Description
request UpdateSnapshotRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateStoragePool(UpdateStoragePoolRequest, ServerCallContext)

public virtual Task<Operation> UpdateStoragePool(UpdateStoragePoolRequest request, ServerCallContext context)

Updates the storage pool properties with the full spec

Parameters
Name Description
request UpdateStoragePoolRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateVolume(UpdateVolumeRequest, ServerCallContext)

public virtual Task<Operation> UpdateVolume(UpdateVolumeRequest request, ServerCallContext context)

Updates the parameters of a single Volume.

Parameters
Name Description
request UpdateVolumeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

VerifyKmsConfig(VerifyKmsConfigRequest, ServerCallContext)

public virtual Task<VerifyKmsConfigResponse> VerifyKmsConfig(VerifyKmsConfigRequest request, ServerCallContext context)

Verifies KMS config reachability.

Parameters
Name Description
request VerifyKmsConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVerifyKmsConfigResponse

The response to send back to the client (wrapped by a task).