Class Volume (0.10.0) 

Volume(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Volume provides a filesystem that you can mount.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
name str
Identifier. Name of the volume
state google.cloud.netapp_v1.types.Volume.State
Output only. State of the volume
state_details str
Output only. State details of the volume
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Create time of the volume
share_name str
Required. Share name of the volume
psa_range str
Output only. This field is not implemented. The values provided in this field are ignored.
storage_pool str
Required. StoragePool name of the volume
network str
Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
service_level google.cloud.netapp_v1.types.ServiceLevel
Output only. Service level of the volume
capacity_gib int
Required. Capacity in GIB of the volume
export_policy google.cloud.netapp_v1.types.ExportPolicy
Optional. Export policy of the volume
protocols MutableSequence[google.cloud.netapp_v1.types.Protocols]
Required. Protocols required for the volume
smb_settings MutableSequence[google.cloud.netapp_v1.types.SMBSettings]
Optional. SMB share settings for the volume.
mount_options MutableSequence[google.cloud.netapp_v1.types.MountOption]
Output only. Mount options of this volume
unix_permissions str
Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
labels MutableMapping[str, str]
Optional. Labels as key value pairs
description str
Optional. Description of the volume
snapshot_policy google.cloud.netapp_v1.types.SnapshotPolicy
Optional. SnapshotPolicy for a volume.
snap_reserve float
Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
snapshot_directory bool
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.
used_gib int
Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
security_style google.cloud.netapp_v1.types.SecurityStyle
Optional. Security Style of the Volume
kerberos_enabled bool
Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
ldap_enabled bool
Output only. Flag indicating if the volume is NFS LDAP enabled or not.
active_directory str
Output only. Specifies the ActiveDirectory name of a SMB volume.
restore_parameters google.cloud.netapp_v1.types.RestoreParameters
Optional. Specifies the source of the volume to be created from.
kms_config str
Output only. Specifies the KMS config to be used for volume encryption.
encryption_type google.cloud.netapp_v1.types.EncryptionType
Output only. Specified the current volume encryption key source.
has_replication bool
Output only. Indicates whether the volume is part of a replication relationship.
backup_config google.cloud.netapp_v1.types.BackupConfig
BackupConfig of the volume. This field is a member of oneof_ _backup_config.
restricted_actions MutableSequence[google.cloud.netapp_v1.types.RestrictedAction]
Optional. List of actions that are restricted on this volume.
large_capacity bool
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.
multiple_endpoints bool
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.
tiering_policy google.cloud.netapp_v1.types.TieringPolicy
Tiering policy for the volume. This field is a member of oneof_ _tiering_policy.
replica_zone str
Output only. Specifies the replica zone for regional volume.
zone str
Output only. Specifies the active zone for regional volume.
cold_tier_size_gib int
Output only. Size of the volume cold tier data rounded down to the nearest GiB.
hybrid_replication_parameters google.cloud.netapp_v1.types.HybridReplicationParameters
Optional. The Hybrid Replication parameters for the volume.
throughput_mibps float
Optional. Throughput of the volume (in MiB/s)
cache_parameters google.cloud.netapp_v1.types.CacheParameters
Optional. Cache parameters for the volume.
hot_tier_size_used_gib int
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
block_devices MutableSequence[google.cloud.netapp_v1.types.BlockDevice]
Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.
large_capacity_config google.cloud.netapp_v1.types.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.
clone_details google.cloud.netapp_v1.types.Volume.CloneDetails
Output only. If this volume is a clone, this field contains details about the clone.

Classes

CloneDetails

CloneDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Details about a clone volume.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

The volume states