Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

NetApp V1 API - Class Google::Cloud::NetApp::V1::Volume (v2.11.0)

Reference documentation and code samples for the NetApp V1 API class Google::Cloud::NetApp::V1::Volume.

Volume provides a filesystem that you can mount.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#active_directory

def active_directory() -> ::String

Returns

(::String) — Output only. Specifies the ActiveDirectory name of a SMB volume.

#backup_config

def backup_config() -> ::Google::Cloud::NetApp::V1::BackupConfig

Returns

(::Google::Cloud::NetApp::V1::BackupConfig) — BackupConfig of the volume.

#backup_config=

def backup_config=(value) -> ::Google::Cloud::NetApp::V1::BackupConfig

Parameter

value (::Google::Cloud::NetApp::V1::BackupConfig) — BackupConfig of the volume.

Returns

(::Google::Cloud::NetApp::V1::BackupConfig) — BackupConfig of the volume.

#block_devices

def block_devices() -> ::Array<::Google::Cloud::NetApp::V1::BlockDevice>

Returns

(::Array<::Google::Cloud::NetApp::V1::BlockDevice>) — Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.

#block_devices=

def block_devices=(value) -> ::Array<::Google::Cloud::NetApp::V1::BlockDevice>

Parameter

value (::Array<::Google::Cloud::NetApp::V1::BlockDevice>) — Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.

Returns

(::Array<::Google::Cloud::NetApp::V1::BlockDevice>) — Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.

#cache_parameters

def cache_parameters() -> ::Google::Cloud::NetApp::V1::CacheParameters

Returns

(::Google::Cloud::NetApp::V1::CacheParameters) — Optional. Cache parameters for the volume.

#cache_parameters=

def cache_parameters=(value) -> ::Google::Cloud::NetApp::V1::CacheParameters

Parameter

value (::Google::Cloud::NetApp::V1::CacheParameters) — Optional. Cache parameters for the volume.

Returns

(::Google::Cloud::NetApp::V1::CacheParameters) — Optional. Cache parameters for the volume.

#capacity_gib

def capacity_gib() -> ::Integer

Returns

(::Integer) — Required. Capacity in GIB of the volume

#capacity_gib=

def capacity_gib=(value) -> ::Integer

Parameter

value (::Integer) — Required. Capacity in GIB of the volume

Returns

(::Integer) — Required. Capacity in GIB of the volume

#clone_details

def clone_details() -> ::Google::Cloud::NetApp::V1::Volume::CloneDetails

Returns

(::Google::Cloud::NetApp::V1::Volume::CloneDetails) — Output only. If this volume is a clone, this field contains details about the clone.

#cold_tier_size_gib

def cold_tier_size_gib() -> ::Integer

Returns

(::Integer) — Output only. Size of the volume cold tier data rounded down to the nearest GiB.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Create time of the volume

#description

def description() -> ::String

Returns

(::String) — Optional. Description of the volume

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. Description of the volume

Returns

(::String) — Optional. Description of the volume

#encryption_type

def encryption_type() -> ::Google::Cloud::NetApp::V1::EncryptionType

Returns

(::Google::Cloud::NetApp::V1::EncryptionType) — Output only. Specified the current volume encryption key source.

#export_policy

def export_policy() -> ::Google::Cloud::NetApp::V1::ExportPolicy

Returns

(::Google::Cloud::NetApp::V1::ExportPolicy) — Optional. Export policy of the volume

#export_policy=

def export_policy=(value) -> ::Google::Cloud::NetApp::V1::ExportPolicy

Parameter

value (::Google::Cloud::NetApp::V1::ExportPolicy) — Optional. Export policy of the volume

Returns

(::Google::Cloud::NetApp::V1::ExportPolicy) — Optional. Export policy of the volume

#has_replication

def has_replication() -> ::Boolean

Returns

(::Boolean) — Output only. Indicates whether the volume is part of a replication relationship.

#hot_tier_size_used_gib

def hot_tier_size_used_gib() -> ::Integer

Returns

(::Integer) — Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level

#hybrid_replication_parameters

def hybrid_replication_parameters() -> ::Google::Cloud::NetApp::V1::HybridReplicationParameters

Returns

(::Google::Cloud::NetApp::V1::HybridReplicationParameters) — Optional. The Hybrid Replication parameters for the volume.

#hybrid_replication_parameters=

def hybrid_replication_parameters=(value) -> ::Google::Cloud::NetApp::V1::HybridReplicationParameters

Parameter

value (::Google::Cloud::NetApp::V1::HybridReplicationParameters) — Optional. The Hybrid Replication parameters for the volume.

Returns

(::Google::Cloud::NetApp::V1::HybridReplicationParameters) — Optional. The Hybrid Replication parameters for the volume.

#kerberos_enabled

def kerberos_enabled() -> ::Boolean

Returns

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

#kerberos_enabled=

def kerberos_enabled=(value) -> ::Boolean

Parameter

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

Returns

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

#kms_config

def kms_config() -> ::String

Returns

(::String) — Output only. Specifies the KMS config to be used for volume encryption.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs

#large_capacity

def large_capacity() -> ::Boolean

Returns

(::Boolean) — Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the large_capacity_config field instead. This field and large_capacity_config are mutually exclusive.

#large_capacity=

def large_capacity=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the large_capacity_config field instead. This field and large_capacity_config are mutually exclusive.

Returns

(::Boolean) — Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the large_capacity_config field instead. This field and large_capacity_config are mutually exclusive.

#large_capacity_config

def large_capacity_config() -> ::Google::Cloud::NetApp::V1::LargeCapacityConfig

Returns

(::Google::Cloud::NetApp::V1::LargeCapacityConfig) — Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy large_capacity boolean field are mutually exclusive.

#large_capacity_config=

def large_capacity_config=(value) -> ::Google::Cloud::NetApp::V1::LargeCapacityConfig

Parameter

value (::Google::Cloud::NetApp::V1::LargeCapacityConfig) — Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy large_capacity boolean field are mutually exclusive.

Returns

(::Google::Cloud::NetApp::V1::LargeCapacityConfig) — Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy large_capacity boolean field are mutually exclusive.

#ldap_enabled

def ldap_enabled() -> ::Boolean

Returns

(::Boolean) — Output only. Flag indicating if the volume is NFS LDAP enabled or not.

#mount_options

def mount_options() -> ::Array<::Google::Cloud::NetApp::V1::MountOption>

Returns

(::Array<::Google::Cloud::NetApp::V1::MountOption>) — Output only. Mount options of this volume

#multiple_endpoints

def multiple_endpoints() -> ::Boolean

Returns

(::Boolean) — Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.

#multiple_endpoints=

def multiple_endpoints=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.

Returns

(::Boolean) — Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.

#name

def name() -> ::String

Returns

(::String) — Identifier. Name of the volume

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. Name of the volume

Returns

(::String) — Identifier. Name of the volume

#network

def network() -> ::String

Returns

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

#protocols

def protocols() -> ::Array<::Google::Cloud::NetApp::V1::Protocols>

Returns

(::Array<::Google::Cloud::NetApp::V1::Protocols>) — Required. Protocols required for the volume

#protocols=

def protocols=(value) -> ::Array<::Google::Cloud::NetApp::V1::Protocols>

Parameter

value (::Array<::Google::Cloud::NetApp::V1::Protocols>) — Required. Protocols required for the volume

Returns

(::Array<::Google::Cloud::NetApp::V1::Protocols>) — Required. Protocols required for the volume

#psa_range

def psa_range() -> ::String

Returns

(::String) — Output only. This field is not implemented. The values provided in this field are ignored.

#replica_zone

def replica_zone() -> ::String

Returns

(::String) — Output only. Specifies the replica zone for regional volume.

#restore_parameters

def restore_parameters() -> ::Google::Cloud::NetApp::V1::RestoreParameters

Returns

(::Google::Cloud::NetApp::V1::RestoreParameters) — Optional. Specifies the source of the volume to be created from.

#restore_parameters=

def restore_parameters=(value) -> ::Google::Cloud::NetApp::V1::RestoreParameters

Parameter

value (::Google::Cloud::NetApp::V1::RestoreParameters) — Optional. Specifies the source of the volume to be created from.

Returns

(::Google::Cloud::NetApp::V1::RestoreParameters) — Optional. Specifies the source of the volume to be created from.

#restricted_actions

def restricted_actions() -> ::Array<::Google::Cloud::NetApp::V1::RestrictedAction>

Returns

(::Array<::Google::Cloud::NetApp::V1::RestrictedAction>) — Optional. List of actions that are restricted on this volume.

#restricted_actions=

def restricted_actions=(value) -> ::Array<::Google::Cloud::NetApp::V1::RestrictedAction>

Parameter

value (::Array<::Google::Cloud::NetApp::V1::RestrictedAction>) — Optional. List of actions that are restricted on this volume.

Returns

(::Array<::Google::Cloud::NetApp::V1::RestrictedAction>) — Optional. List of actions that are restricted on this volume.

#security_style

def security_style() -> ::Google::Cloud::NetApp::V1::SecurityStyle

Returns

(::Google::Cloud::NetApp::V1::SecurityStyle) — Optional. Security Style of the Volume

#security_style=

def security_style=(value) -> ::Google::Cloud::NetApp::V1::SecurityStyle

Parameter

value (::Google::Cloud::NetApp::V1::SecurityStyle) — Optional. Security Style of the Volume

Returns

(::Google::Cloud::NetApp::V1::SecurityStyle) — Optional. Security Style of the Volume

#service_level

def service_level() -> ::Google::Cloud::NetApp::V1::ServiceLevel

Returns

(::Google::Cloud::NetApp::V1::ServiceLevel) — Output only. Service level of the volume

#share_name

def share_name() -> ::String

Returns

(::String) — Required. Share name of the volume

#share_name=

def share_name=(value) -> ::String

Parameter

value (::String) — Required. Share name of the volume

Returns

(::String) — Required. Share name of the volume

#smb_settings

def smb_settings() -> ::Array<::Google::Cloud::NetApp::V1::SMBSettings>

Returns

(::Array<::Google::Cloud::NetApp::V1::SMBSettings>) — Optional. SMB share settings for the volume.

#smb_settings=

def smb_settings=(value) -> ::Array<::Google::Cloud::NetApp::V1::SMBSettings>

Parameter

value (::Array<::Google::Cloud::NetApp::V1::SMBSettings>) — Optional. SMB share settings for the volume.

Returns

(::Array<::Google::Cloud::NetApp::V1::SMBSettings>) — Optional. SMB share settings for the volume.

#snap_reserve

def snap_reserve() -> ::Float

Returns

(::Float) — Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

#snap_reserve=

def snap_reserve=(value) -> ::Float

Parameter

value (::Float) — Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

Returns

(::Float) — Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

#snapshot_directory

def snapshot_directory() -> ::Boolean

Returns

(::Boolean) — 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.

#snapshot_directory=

def snapshot_directory=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.

#snapshot_policy

def snapshot_policy() -> ::Google::Cloud::NetApp::V1::SnapshotPolicy

Returns

(::Google::Cloud::NetApp::V1::SnapshotPolicy) — Optional. SnapshotPolicy for a volume.

#snapshot_policy=

def snapshot_policy=(value) -> ::Google::Cloud::NetApp::V1::SnapshotPolicy

Parameter

value (::Google::Cloud::NetApp::V1::SnapshotPolicy) — Optional. SnapshotPolicy for a volume.

Returns

(::Google::Cloud::NetApp::V1::SnapshotPolicy) — Optional. SnapshotPolicy for a volume.

#state

def state() -> ::Google::Cloud::NetApp::V1::Volume::State

Returns

(::Google::Cloud::NetApp::V1::Volume::State) — Output only. State of the volume

#state_details

def state_details() -> ::String

Returns

(::String) — Output only. State details of the volume

#storage_pool

def storage_pool() -> ::String

Returns

(::String) — Required. StoragePool name of the volume

#storage_pool=

def storage_pool=(value) -> ::String

Parameter

value (::String) — Required. StoragePool name of the volume

Returns

(::String) — Required. StoragePool name of the volume

#throughput_mibps

def throughput_mibps() -> ::Float

Returns

(::Float) — Optional. Throughput of the volume (in MiB/s)

#throughput_mibps=

def throughput_mibps=(value) -> ::Float

Parameter

value (::Float) — Optional. Throughput of the volume (in MiB/s)

Returns

(::Float) — Optional. Throughput of the volume (in MiB/s)

#tiering_policy

def tiering_policy() -> ::Google::Cloud::NetApp::V1::TieringPolicy

Returns

(::Google::Cloud::NetApp::V1::TieringPolicy) — Tiering policy for the volume.

#tiering_policy=

def tiering_policy=(value) -> ::Google::Cloud::NetApp::V1::TieringPolicy

Parameter

value (::Google::Cloud::NetApp::V1::TieringPolicy) — Tiering policy for the volume.

Returns

(::Google::Cloud::NetApp::V1::TieringPolicy) — Tiering policy for the volume.

#unix_permissions

def unix_permissions() -> ::String

Returns

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

#unix_permissions=

def unix_permissions=(value) -> ::String

Parameter

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

Returns

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

#used_gib

def used_gib() -> ::Integer

Returns

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

#zone

def zone() -> ::String

Returns

(::String) — Output only. Specifies the active zone for regional volume.