Interface VolumeOrBuilder (0.22.0) 

public interface VolumeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels as key value pairs

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getActiveDirectory()

public abstract String getActiveDirectory()

Output only. Specifies the ActiveDirectory name of a SMB volume.

string active_directory = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The activeDirectory.

getActiveDirectoryBytes()

public abstract ByteString getActiveDirectoryBytes()

Output only. Specifies the ActiveDirectory name of a SMB volume.

string active_directory = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for activeDirectory.

getBackupConfig()

public abstract BackupConfig getBackupConfig()

BackupConfig of the volume.

optional .google.cloud.netapp.v1.BackupConfig backup_config = 30;

Returns
Type Description
BackupConfig

The backupConfig.

getBackupConfigOrBuilder()

public abstract BackupConfigOrBuilder getBackupConfigOrBuilder()

BackupConfig of the volume.

optional .google.cloud.netapp.v1.BackupConfig backup_config = 30;

Returns
Type Description
BackupConfigOrBuilder

getCapacityGib()

public abstract long getCapacityGib()

Required. Capacity in GIB of the volume

int64 capacity_gib = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The capacityGib.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create time of the volume

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the volume

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the volume

string description = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the volume

string description = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEncryptionType()

public abstract EncryptionType getEncryptionType()

Output only. Specified the current volume encryption key source.

.google.cloud.netapp.v1.EncryptionType encryption_type = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionType

The encryptionType.

getEncryptionTypeValue()

public abstract int getEncryptionTypeValue()

Output only. Specified the current volume encryption key source.

.google.cloud.netapp.v1.EncryptionType encryption_type = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for encryptionType.

getExportPolicy()

public abstract ExportPolicy getExportPolicy()

Optional. Export policy of the volume

.google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportPolicy

The exportPolicy.

getExportPolicyOrBuilder()

public abstract ExportPolicyOrBuilder getExportPolicyOrBuilder()

Optional. Export policy of the volume

.google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportPolicyOrBuilder

getHasReplication()

public abstract boolean getHasReplication()

Output only. Indicates whether the volume is part of a replication relationship.

bool has_replication = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The hasReplication.

getKerberosEnabled()

public abstract boolean getKerberosEnabled()

Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).

bool kerberos_enabled = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The kerberosEnabled.

getKmsConfig()

public abstract String getKmsConfig()

Output only. Specifies the KMS config to be used for volume encryption.

string kms_config = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsConfig.

getKmsConfigBytes()

public abstract ByteString getKmsConfigBytes()

Output only. Specifies the KMS config to be used for volume encryption.

string kms_config = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsConfig.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels as key value pairs

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels as key value pairs

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLdapEnabled()

public abstract boolean getLdapEnabled()

Output only. Flag indicating if the volume is NFS LDAP enabled or not.

bool ldap_enabled = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The ldapEnabled.

getMountOptions(int index)

public abstract MountOption getMountOptions(int index)

Output only. Mount options of this volume

repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MountOption

getMountOptionsCount()

public abstract int getMountOptionsCount()

Output only. Mount options of this volume

repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getMountOptionsList()

public abstract List<MountOption> getMountOptionsList()

Output only. Mount options of this volume

repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<MountOption>

getMountOptionsOrBuilder(int index)

public abstract MountOptionOrBuilder getMountOptionsOrBuilder(int index)

Output only. Mount options of this volume

repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MountOptionOrBuilder

getMountOptionsOrBuilderList()

public abstract List<? extends MountOptionOrBuilder> getMountOptionsOrBuilderList()

Output only. Mount options of this volume

repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.netapp.v1.MountOptionOrBuilder>

getName()

public abstract String getName()

Identifier. Name of the volume

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of the volume

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public abstract String getNetwork()

Output only. VPC Network name. Format: projects/{project}/global/networks/{network}

string network = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

Output only. VPC Network name. Format: projects/{project}/global/networks/{network}

string network = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getProtocols(int index)

public abstract Protocols getProtocols(int index)

Required. Protocols required for the volume

repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Protocols

The protocols at the given index.

getProtocolsCount()

public abstract int getProtocolsCount()

Required. Protocols required for the volume

repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of protocols.

getProtocolsList()

public abstract List<Protocols> getProtocolsList()

Required. Protocols required for the volume

repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Protocols>

A list containing the protocols.

getProtocolsValue(int index)

public abstract int getProtocolsValue(int index)

Required. Protocols required for the volume

repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of protocols at the given index.

getProtocolsValueList()

public abstract List<Integer> getProtocolsValueList()

Required. Protocols required for the volume

repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for protocols.

getPsaRange()

public abstract String getPsaRange()

Output only. This field is not implemented. The values provided in this field are ignored.

string psa_range = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The psaRange.

getPsaRangeBytes()

public abstract ByteString getPsaRangeBytes()

Output only. This field is not implemented. The values provided in this field are ignored.

string psa_range = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for psaRange.

getRestoreParameters()

public abstract RestoreParameters getRestoreParameters()

Optional. Specifies the source of the volume to be created from.

.google.cloud.netapp.v1.RestoreParameters restore_parameters = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreParameters

The restoreParameters.

getRestoreParametersOrBuilder()

public abstract RestoreParametersOrBuilder getRestoreParametersOrBuilder()

Optional. Specifies the source of the volume to be created from.

.google.cloud.netapp.v1.RestoreParameters restore_parameters = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreParametersOrBuilder

getRestrictedActions(int index)

public abstract RestrictedAction getRestrictedActions(int index)

Optional. List of actions that are restricted on this volume.

repeated .google.cloud.netapp.v1.RestrictedAction restricted_actions = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
RestrictedAction

The restrictedActions at the given index.

getRestrictedActionsCount()

public abstract int getRestrictedActionsCount()

Optional. List of actions that are restricted on this volume.

repeated .google.cloud.netapp.v1.RestrictedAction restricted_actions = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of restrictedActions.

getRestrictedActionsList()

public abstract List<RestrictedAction> getRestrictedActionsList()

Optional. List of actions that are restricted on this volume.

repeated .google.cloud.netapp.v1.RestrictedAction restricted_actions = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<RestrictedAction>

A list containing the restrictedActions.

getRestrictedActionsValue(int index)

public abstract int getRestrictedActionsValue(int index)

Optional. List of actions that are restricted on this volume.

repeated .google.cloud.netapp.v1.RestrictedAction restricted_actions = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of restrictedActions at the given index.

getRestrictedActionsValueList()

public abstract List<Integer> getRestrictedActionsValueList()

Optional. List of actions that are restricted on this volume.

repeated .google.cloud.netapp.v1.RestrictedAction restricted_actions = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for restrictedActions.

getSecurityStyle()

public abstract SecurityStyle getSecurityStyle()

Optional. Security Style of the Volume

.google.cloud.netapp.v1.SecurityStyle security_style = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SecurityStyle

The securityStyle.

getSecurityStyleValue()

public abstract int getSecurityStyleValue()

Optional. Security Style of the Volume

.google.cloud.netapp.v1.SecurityStyle security_style = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for securityStyle.

getServiceLevel()

public abstract ServiceLevel getServiceLevel()

Output only. Service level of the volume

.google.cloud.netapp.v1.ServiceLevel service_level = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceLevel

The serviceLevel.

getServiceLevelValue()

public abstract int getServiceLevelValue()

Output only. Service level of the volume

.google.cloud.netapp.v1.ServiceLevel service_level = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for serviceLevel.

getShareName()

public abstract String getShareName()

Required. Share name of the volume

string share_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The shareName.

getShareNameBytes()

public abstract ByteString getShareNameBytes()

Required. Share name of the volume

string share_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for shareName.

getSmbSettings(int index)

public abstract SMBSettings getSmbSettings(int index)

Optional. SMB share settings for the volume.

repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
SMBSettings

The smbSettings at the given index.

getSmbSettingsCount()

public abstract int getSmbSettingsCount()

Optional. SMB share settings for the volume.

repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of smbSettings.

getSmbSettingsList()

public abstract List<SMBSettings> getSmbSettingsList()

Optional. SMB share settings for the volume.

repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SMBSettings>

A list containing the smbSettings.

getSmbSettingsValue(int index)

public abstract int getSmbSettingsValue(int index)

Optional. SMB share settings for the volume.

repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of smbSettings at the given index.

getSmbSettingsValueList()

public abstract List<Integer> getSmbSettingsValueList()

Optional. SMB share settings for the volume.

repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for smbSettings.

getSnapReserve()

public abstract double getSnapReserve()

Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

double snap_reserve = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The snapReserve.

getSnapshotDirectory()

public abstract boolean getSnapshotDirectory()

Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.

bool snapshot_directory = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The snapshotDirectory.

getSnapshotPolicy()

public abstract SnapshotPolicy getSnapshotPolicy()

Optional. SnapshotPolicy for a volume.

.google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SnapshotPolicy

The snapshotPolicy.

getSnapshotPolicyOrBuilder()

public abstract SnapshotPolicyOrBuilder getSnapshotPolicyOrBuilder()

Optional. SnapshotPolicy for a volume.

.google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SnapshotPolicyOrBuilder

getState()

public abstract Volume.State getState()

Output only. State of the volume

.google.cloud.netapp.v1.Volume.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Volume.State

The state.

getStateDetails()

public abstract String getStateDetails()

Output only. State details of the volume

string state_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDetails.

getStateDetailsBytes()

public abstract ByteString getStateDetailsBytes()

Output only. State details of the volume

string state_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDetails.

getStateValue()

public abstract int getStateValue()

Output only. State of the volume

.google.cloud.netapp.v1.Volume.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStoragePool()

public abstract String getStoragePool()

Required. StoragePool name of the volume

string storage_pool = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The storagePool.

getStoragePoolBytes()

public abstract ByteString getStoragePoolBytes()

Required. StoragePool name of the volume

string storage_pool = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for storagePool.

getUnixPermissions()

public abstract String getUnixPermissions()

Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.

string unix_permissions = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The unixPermissions.

getUnixPermissionsBytes()

public abstract ByteString getUnixPermissionsBytes()

Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.

string unix_permissions = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for unixPermissions.

getUsedGib()

public abstract long getUsedGib()

Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.

int64 used_gib = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The usedGib.

hasBackupConfig()

public abstract boolean hasBackupConfig()

BackupConfig of the volume.

optional .google.cloud.netapp.v1.BackupConfig backup_config = 30;

Returns
Type Description
boolean

Whether the backupConfig field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create time of the volume

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExportPolicy()

public abstract boolean hasExportPolicy()

Optional. Export policy of the volume

.google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exportPolicy field is set.

hasRestoreParameters()

public abstract boolean hasRestoreParameters()

Optional. Specifies the source of the volume to be created from.

.google.cloud.netapp.v1.RestoreParameters restore_parameters = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the restoreParameters field is set.

hasSnapshotPolicy()

public abstract boolean hasSnapshotPolicy()

Optional. SnapshotPolicy for a volume.

.google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the snapshotPolicy field is set.