Package com.google.cloud.netapp.v1

Interface VolumeOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Volume, Volume.Builder
    public interface VolumeOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. Name of the volume
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the volume
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getStateValue

        int getStateValue()
         Output only. State of the volume
        .google.cloud.netapp.v1.Volume.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Volume.State getState()
         Output only. State of the volume
        .google.cloud.netapp.v1.Volume.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getStateDetails

        String getStateDetails()
         Output only. State details of the volume
        string state_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The stateDetails.

      • getStateDetailsBytes

        com.google.protobuf.ByteString getStateDetailsBytes()
         Output only. State details of the volume
        string state_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for stateDetails.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Create time of the volume
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time of the volume
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create time of the volume
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getShareName

        String getShareName()
         Required. Share name of the volume
        string share_name = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The shareName.

      • getShareNameBytes

        com.google.protobuf.ByteString getShareNameBytes()
         Required. Share name of the volume
        string share_name = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for shareName.

      • getPsaRange

        String getPsaRange()
         Output only. Name of the Private Service Access allocated range. This is
 optional. If not provided, any available range will be chosen.
        string psa_range = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The psaRange.

      • getPsaRangeBytes

        com.google.protobuf.ByteString getPsaRangeBytes()
         Output only. Name of the Private Service Access allocated range. This is
 optional. If not provided, any available range will be chosen.
        string psa_range = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for psaRange.

      • getStoragePool

        String getStoragePool()
         Required. StoragePool name of the volume
        string storage_pool = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The storagePool.

      • getStoragePoolBytes

        com.google.protobuf.ByteString getStoragePoolBytes()
         Required. StoragePool name of the volume
        string storage_pool = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for storagePool.

      • getNetwork

        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:
        The network.

      • getNetworkBytes

        com.google.protobuf.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:
        The bytes for network.

      • getServiceLevelValue

        int getServiceLevelValue()
         Output only. Service level of the volume
        .google.cloud.netapp.v1.ServiceLevel service_level = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for serviceLevel.

      • getServiceLevel

        ServiceLevel getServiceLevel()
         Output only. Service level of the volume
        .google.cloud.netapp.v1.ServiceLevel service_level = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The serviceLevel.

      • getCapacityGib

        long getCapacityGib()
         Required. Capacity in GIB of the volume
        int64 capacity_gib = 10 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The capacityGib.

      • hasExportPolicy

        boolean hasExportPolicy()
         Optional. Export policy of the volume
        .google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the exportPolicy field is set.

      • getExportPolicy

        ExportPolicy getExportPolicy()
         Optional. Export policy of the volume
        .google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The exportPolicy.

      • getExportPolicyOrBuilder

        ExportPolicyOrBuilder getExportPolicyOrBuilder()
         Optional. Export policy of the volume
        .google.cloud.netapp.v1.ExportPolicy export_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getProtocolsList

        List<Protocols> getProtocolsList()
         Required. Protocols required for the volume
        repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the protocols.

      • getProtocolsCount

        int getProtocolsCount()
         Required. Protocols required for the volume
        repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The count of protocols.

      • getProtocols

        Protocols getProtocols​(int index)
         Required. Protocols required for the volume
        repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the element to return.
        Returns:
        The protocols at the given index.

      • getProtocolsValueList

        List<Integer> getProtocolsValueList()
         Required. Protocols required for the volume
        repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the enum numeric values on the wire for protocols.

      • getProtocolsValue

        int getProtocolsValue​(int index)
         Required. Protocols required for the volume
        repeated .google.cloud.netapp.v1.Protocols protocols = 12 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of protocols at the given index.

      • getSmbSettingsList

        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:
        A list containing the smbSettings.

      • getSmbSettingsCount

        int getSmbSettingsCount()
         Optional. SMB share settings for the volume.
        repeated .google.cloud.netapp.v1.SMBSettings smb_settings = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of smbSettings.

      • getSmbSettings

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The smbSettings at the given index.

      • getSmbSettingsValueList

        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:
        A list containing the enum numeric values on the wire for smbSettings.

      • getSmbSettingsValue

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of smbSettings at the given index.

      • getMountOptionsList

        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];

      • getMountOptions

        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];

      • getMountOptionsCount

        int getMountOptionsCount()
         Output only. Mount options of this volume
        repeated .google.cloud.netapp.v1.MountOption mount_options = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMountOptionsOrBuilderList

        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];

      • getMountOptionsOrBuilder

        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];

      • getUnixPermissions

        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:
        The unixPermissions.

      • getUnixPermissionsBytes

        com.google.protobuf.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:
        The bytes for unixPermissions.

      • getLabelsCount

        int getLabelsCount()
         Optional. Labels as key value pairs
        map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        boolean containsLabels​(String key)
         Optional. Labels as key value pairs
        map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Optional. Labels as key value pairs
        map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Optional. Labels as key value pairs
        map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Optional. Labels as key value pairs
        map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

      • getDescription

        String getDescription()
         Optional. Description of the volume
        string description = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Description of the volume
        string description = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for description.

      • hasSnapshotPolicy

        boolean hasSnapshotPolicy()
         Optional. SnapshotPolicy for a volume.
        .google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the snapshotPolicy field is set.

      • getSnapshotPolicy

        SnapshotPolicy getSnapshotPolicy()
         Optional. SnapshotPolicy for a volume.
        .google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The snapshotPolicy.

      • getSnapshotPolicyOrBuilder

        SnapshotPolicyOrBuilder getSnapshotPolicyOrBuilder()
         Optional. SnapshotPolicy for a volume.
        .google.cloud.netapp.v1.SnapshotPolicy snapshot_policy = 18 [(.google.api.field_behavior) = OPTIONAL];

      • getSnapReserve

        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:
        The snapReserve.

      • getSnapshotDirectory

        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:
        The snapshotDirectory.

      • getUsedGib

        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:
        The usedGib.

      • getSecurityStyleValue

        int getSecurityStyleValue()
         Optional. Security Style of the Volume
        .google.cloud.netapp.v1.SecurityStyle security_style = 22 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for securityStyle.

      • getSecurityStyle

        SecurityStyle getSecurityStyle()
         Optional. Security Style of the Volume
        .google.cloud.netapp.v1.SecurityStyle security_style = 22 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The securityStyle.

      • getKerberosEnabled

        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:
        The kerberosEnabled.

      • getLdapEnabled

        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:
        The ldapEnabled.

      • getActiveDirectory

        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:
        The activeDirectory.

      • getActiveDirectoryBytes

        com.google.protobuf.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:
        The bytes for activeDirectory.

      • hasRestoreParameters

        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:
        Whether the restoreParameters field is set.

      • getRestoreParameters

        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:
        The restoreParameters.

      • getRestoreParametersOrBuilder

        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];

      • getKmsConfig

        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:
        The kmsConfig.

      • getKmsConfigBytes

        com.google.protobuf.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:
        The bytes for kmsConfig.

      • getEncryptionTypeValue

        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:
        The enum numeric value on the wire for encryptionType.

      • getEncryptionType

        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:
        The encryptionType.

      • getHasReplication

        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:
        The hasReplication.

      • getRestrictedActionsList

        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:
        A list containing the restrictedActions.

      • getRestrictedActionsCount

        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:
        The count of restrictedActions.

      • getRestrictedActions

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The restrictedActions at the given index.

      • getRestrictedActionsValueList

        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:
        A list containing the enum numeric values on the wire for restrictedActions.

      • getRestrictedActionsValue

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of restrictedActions at the given index.