Google Cloud Net App V1 Client - Class Volume (1.12.0)

1.12.0 (latest) 1.11.0 1.10.2 1.9.0 1.8.1 1.7.0 1.6.1 1.4.0 1.3.1 1.2.1 1.1.1 1.0.1 0.3.1 0.2.6 0.1.1

Reference documentation and code samples for the Google Cloud Net App V1 Client class Volume.

Volume provides a filesystem that you can mount.

Generated from protobuf message google.cloud.netapp.v1.Volume

Namespace

Google \ Cloud \ NetApp \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. Name of the volume
↳ state	int Output only. State of the volume
↳ state_details	string Output only. State details of the volume
↳ create_time	Google\Protobuf\Timestamp Output only. Create time of the volume
↳ share_name	string Required. Share name of the volume
↳ psa_range	string Output only. This field is not implemented. The values provided in this field are ignored.
↳ storage_pool	string Required. StoragePool name of the volume
↳ network	string Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
↳ service_level	int Output only. Service level of the volume
↳ capacity_gib	int|string Required. Capacity in GIB of the volume
↳ export_policy	ExportPolicy Optional. Export policy of the volume
↳ protocols	int[] Required. Protocols required for the volume
↳ smb_settings	int[] Optional. SMB share settings for the volume.
↳ mount_options	array<MountOption> Output only. Mount options of this volume
↳ unix_permissions	string Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Labels as key value pairs
↳ description	string Optional. Description of the volume
↳ snapshot_policy	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|string Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
↳ security_style	int 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	string Output only. Specifies the ActiveDirectory name of a SMB volume.
↳ restore_parameters	RestoreParameters Optional. Specifies the source of the volume to be created from.
↳ kms_config	string Output only. Specifies the KMS config to be used for volume encryption.
↳ encryption_type	int 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	BackupConfig BackupConfig of the volume.
↳ restricted_actions	int[] 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	TieringPolicy Tiering policy for the volume.
↳ replica_zone	string Output only. Specifies the replica zone for regional volume.
↳ zone	string Output only. Specifies the active zone for regional volume.
↳ cold_tier_size_gib	int|string Output only. Size of the volume cold tier data rounded down to the nearest GiB.
↳ hybrid_replication_parameters	HybridReplicationParameters Optional. The Hybrid Replication parameters for the volume.
↳ throughput_mibps	float Optional. Throughput of the volume (in MiB/s)
↳ cache_parameters	CacheParameters Optional. Cache parameters for the volume.
↳ hot_tier_size_used_gib	int|string 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	array<BlockDevice> Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.
↳ large_capacity_config	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	Volume\CloneDetails Output only. If this volume is a clone, this field contains details about the clone.

getName

Identifier. Name of the volume

Returns
Type	Description
string

setName

Identifier. Name of the volume

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. State of the volume

Returns
Type	Description
int	Enum of type State.

setState

Output only. State of the volume

Parameter
Name	Description
var	int Enum of type State.

Returns
Type	Description
$this

getStateDetails

Output only. State details of the volume

Returns
Type	Description
string

setStateDetails

Output only. State details of the volume

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Create time of the volume

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time of the volume

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getShareName

Required. Share name of the volume

Returns
Type	Description
string

setShareName

Required. Share name of the volume

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPsaRange

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

Returns
Type	Description
string

setPsaRange

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStoragePool

Required. StoragePool name of the volume

Returns
Type	Description
string

setStoragePool

Required. StoragePool name of the volume

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNetwork

Output only. VPC Network name.

Format: projects/{project}/global/networks/{network}

Returns
Type	Description
string

setNetwork

Output only. VPC Network name.

Format: projects/{project}/global/networks/{network}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getServiceLevel

Output only. Service level of the volume

Returns
Type	Description
int	Enum of type ServiceLevel.

setServiceLevel

Output only. Service level of the volume

Parameter
Name	Description
var	int Enum of type ServiceLevel.

Returns
Type	Description
$this

getCapacityGib

Required. Capacity in GIB of the volume

Returns
Type	Description
int|string

setCapacityGib

Required. Capacity in GIB of the volume

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getExportPolicy

Optional. Export policy of the volume

Returns
Type	Description
ExportPolicy|null

hasExportPolicy

clearExportPolicy

setExportPolicy

Optional. Export policy of the volume

Parameter
Name	Description
var	ExportPolicy

Returns
Type	Description
$this

getProtocols

Required. Protocols required for the volume

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setProtocols

Required. Protocols required for the volume

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getSmbSettings

Optional. SMB share settings for the volume.

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setSmbSettings

Optional. SMB share settings for the volume.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getMountOptions

Output only. Mount options of this volume

Returns
Type	Description
Google\Protobuf\RepeatedField<MountOption>

setMountOptions

Output only. Mount options of this volume

Parameter
Name	Description
var	array<MountOption>

Returns
Type	Description
$this

getUnixPermissions

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

Returns
Type	Description
string

setUnixPermissions

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLabels

Optional. Labels as key value pairs

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels as key value pairs

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDescription

Optional. Description of the volume

Returns
Type	Description
string

setDescription

Optional. Description of the volume

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSnapshotPolicy

Optional. SnapshotPolicy for a volume.

Returns
Type	Description
SnapshotPolicy|null

hasSnapshotPolicy

clearSnapshotPolicy

setSnapshotPolicy

Optional. SnapshotPolicy for a volume.

Parameter
Name	Description
var	SnapshotPolicy

Returns
Type	Description
$this

getSnapReserve

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

Returns
Type	Description
float

setSnapReserve

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

Parameter
Name	Description
var	float

Returns
Type	Description
$this

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.

Returns
Type	Description
bool

setSnapshotDirectory

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getUsedGib

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

Returns
Type	Description
int|string

setUsedGib

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

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getSecurityStyle

Optional. Security Style of the Volume

Returns
Type	Description
int	Enum of type SecurityStyle.

setSecurityStyle

Optional. Security Style of the Volume

Parameter
Name	Description
var	int Enum of type SecurityStyle.

Returns
Type	Description
$this

getKerberosEnabled

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

Returns
Type	Description
bool

setKerberosEnabled

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getLdapEnabled

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

Returns
Type	Description
bool

setLdapEnabled

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getActiveDirectory

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

Returns
Type	Description
string

setActiveDirectory

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRestoreParameters

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

Returns
Type	Description
RestoreParameters|null

hasRestoreParameters

clearRestoreParameters

setRestoreParameters

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

Parameter
Name	Description
var	RestoreParameters

Returns
Type	Description
$this

getKmsConfig

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

Returns
Type	Description
string

setKmsConfig

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEncryptionType

Output only. Specified the current volume encryption key source.

Returns
Type	Description
int	Enum of type EncryptionType.

setEncryptionType

Output only. Specified the current volume encryption key source.

Parameter
Name	Description
var	int Enum of type EncryptionType.

Returns
Type	Description
$this

getHasReplication

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

Returns
Type	Description
bool

setHasReplication

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getBackupConfig

BackupConfig of the volume.

Returns
Type	Description
BackupConfig|null

hasBackupConfig

clearBackupConfig

setBackupConfig

BackupConfig of the volume.

Parameter
Name	Description
var	BackupConfig

Returns
Type	Description
$this

getRestrictedActions

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

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setRestrictedActions

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

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getLargeCapacity

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
Type	Description
bool

setLargeCapacity

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getMultipleEndpoints

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
Type	Description
bool

setMultipleEndpoints

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getTieringPolicy

Tiering policy for the volume.

Returns
Type	Description
TieringPolicy|null

hasTieringPolicy

clearTieringPolicy

setTieringPolicy

Tiering policy for the volume.

Parameter
Name	Description
var	TieringPolicy

Returns
Type	Description
$this

getReplicaZone

Output only. Specifies the replica zone for regional volume.

Returns
Type	Description
string

setReplicaZone

Output only. Specifies the replica zone for regional volume.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getZone

Output only. Specifies the active zone for regional volume.

Returns
Type	Description
string

setZone

Output only. Specifies the active zone for regional volume.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getColdTierSizeGib

Output only. Size of the volume cold tier data rounded down to the nearest GiB.

Returns
Type	Description
int|string

setColdTierSizeGib

Output only. Size of the volume cold tier data rounded down to the nearest GiB.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getHybridReplicationParameters

Optional. The Hybrid Replication parameters for the volume.

Returns
Type	Description
HybridReplicationParameters|null

hasHybridReplicationParameters

clearHybridReplicationParameters

setHybridReplicationParameters

Optional. The Hybrid Replication parameters for the volume.

Parameter
Name	Description
var	HybridReplicationParameters

Returns
Type	Description
$this

getThroughputMibps

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

Returns
Type	Description
float

setThroughputMibps

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

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getCacheParameters

Optional. Cache parameters for the volume.

Returns
Type	Description
CacheParameters|null

hasCacheParameters

clearCacheParameters

setCacheParameters

Optional. Cache parameters for the volume.

Parameter
Name	Description
var	CacheParameters

Returns
Type	Description
$this

getHotTierSizeUsedGib

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

Returns
Type	Description
int|string

setHotTierSizeUsedGib

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

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getBlockDevices

Optional. Block devices for the volume.

Currently, only one block device is permitted per Volume.

Returns
Type	Description
Google\Protobuf\RepeatedField<BlockDevice>

setBlockDevices

Optional. Block devices for the volume.

Currently, only one block device is permitted per Volume.

Parameter
Name	Description
var	array<BlockDevice>

Returns
Type	Description
$this

getLargeCapacityConfig

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
Type	Description
LargeCapacityConfig|null

hasLargeCapacityConfig

clearLargeCapacityConfig

setLargeCapacityConfig

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.

Parameter
Name	Description
var	LargeCapacityConfig

Returns
Type	Description
$this

getCloneDetails

Output only. If this volume is a clone, this field contains details about the clone.

Returns
Type	Description
Volume\CloneDetails|null

hasCloneDetails

clearCloneDetails

setCloneDetails

Output only. If this volume is a clone, this field contains details about the clone.

Parameter
Name	Description
var	Volume\CloneDetails

Returns
Type	Description
$this