Class FileShareProperties
- java.lang.Object
-
- com.azure.resourcemanager.storage.fluent.models.FileShareProperties
-
public final class FileShareProperties extends Object
The properties of the file share.
-
-
Constructor Summary
Constructors Constructor Description FileShareProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ShareAccessTieraccessTier()Get the accessTier property: Access tier for specific share.OffsetDateTimeaccessTierChangeTime()Get the accessTierChangeTime property: Indicates the last modification time for share access tier.StringaccessTierStatus()Get the accessTierStatus property: Indicates if there is a pending transition for access tier.Booleandeleted()Get the deleted property: Indicates whether the share was deleted.OffsetDateTimedeletedTime()Get the deletedTime property: The deleted time if the share was deleted.EnabledProtocolsenabledProtocols()Get the enabledProtocols property: The authentication protocol that is used for the file share.OffsetDateTimelastModifiedTime()Get the lastModifiedTime property: Returns the date and time the share was last modified.LeaseDurationleaseDuration()Get the leaseDuration property: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.LeaseStateleaseState()Get the leaseState property: Lease state of the share.LeaseStatusleaseStatus()Get the leaseStatus property: The lease status of the share.Map<String,String>metadata()Get the metadata property: A name-value pair to associate with the share as metadata.IntegerremainingRetentionDays()Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.RootSquashTyperootSquash()Get the rootSquash property: The property is for NFS share only.IntegershareQuota()Get the shareQuota property: The maximum size of the share, in gigabytes.LongshareUsageBytes()Get the shareUsageBytes property: The approximate size of the data stored on the share.List<SignedIdentifier>signedIdentifiers()Get the signedIdentifiers property: List of stored access policies specified on the share.OffsetDateTimesnapshotTime()Get the snapshotTime property: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".voidvalidate()Validates the instance.Stringversion()Get the version property: The version of the share.FileSharePropertieswithAccessTier(ShareAccessTier accessTier)Set the accessTier property: Access tier for specific share.FileSharePropertieswithEnabledProtocols(EnabledProtocols enabledProtocols)Set the enabledProtocols property: The authentication protocol that is used for the file share.FileSharePropertieswithMetadata(Map<String,String> metadata)Set the metadata property: A name-value pair to associate with the share as metadata.FileSharePropertieswithRootSquash(RootSquashType rootSquash)Set the rootSquash property: The property is for NFS share only.FileSharePropertieswithShareQuota(Integer shareQuota)Set the shareQuota property: The maximum size of the share, in gigabytes.FileSharePropertieswithSignedIdentifiers(List<SignedIdentifier> signedIdentifiers)Set the signedIdentifiers property: List of stored access policies specified on the share.
-
-
-
Method Detail
-
lastModifiedTime
public OffsetDateTime lastModifiedTime()
Get the lastModifiedTime property: Returns the date and time the share was last modified.- Returns:
- the lastModifiedTime value.
-
metadata
public Map<String,String> metadata()
Get the metadata property: A name-value pair to associate with the share as metadata.- Returns:
- the metadata value.
-
withMetadata
public FileShareProperties withMetadata(Map<String,String> metadata)
Set the metadata property: A name-value pair to associate with the share as metadata.- Parameters:
metadata- the metadata value to set.- Returns:
- the FileShareProperties object itself.
-
shareQuota
public Integer shareQuota()
Get the shareQuota property: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.- Returns:
- the shareQuota value.
-
withShareQuota
public FileShareProperties withShareQuota(Integer shareQuota)
Set the shareQuota property: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.- Parameters:
shareQuota- the shareQuota value to set.- Returns:
- the FileShareProperties object itself.
-
enabledProtocols
public EnabledProtocols enabledProtocols()
Get the enabledProtocols property: The authentication protocol that is used for the file share. Can only be specified when creating a share.- Returns:
- the enabledProtocols value.
-
withEnabledProtocols
public FileShareProperties withEnabledProtocols(EnabledProtocols enabledProtocols)
Set the enabledProtocols property: The authentication protocol that is used for the file share. Can only be specified when creating a share.- Parameters:
enabledProtocols- the enabledProtocols value to set.- Returns:
- the FileShareProperties object itself.
-
rootSquash
public RootSquashType rootSquash()
Get the rootSquash property: The property is for NFS share only. The default is NoRootSquash.- Returns:
- the rootSquash value.
-
withRootSquash
public FileShareProperties withRootSquash(RootSquashType rootSquash)
Set the rootSquash property: The property is for NFS share only. The default is NoRootSquash.- Parameters:
rootSquash- the rootSquash value to set.- Returns:
- the FileShareProperties object itself.
-
version
public String version()
Get the version property: The version of the share.- Returns:
- the version value.
-
deleted
public Boolean deleted()
Get the deleted property: Indicates whether the share was deleted.- Returns:
- the deleted value.
-
deletedTime
public OffsetDateTime deletedTime()
Get the deletedTime property: The deleted time if the share was deleted.- Returns:
- the deletedTime value.
-
remainingRetentionDays
public Integer remainingRetentionDays()
Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.- Returns:
- the remainingRetentionDays value.
-
accessTier
public ShareAccessTier accessTier()
Get the accessTier property: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.- Returns:
- the accessTier value.
-
withAccessTier
public FileShareProperties withAccessTier(ShareAccessTier accessTier)
Set the accessTier property: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.- Parameters:
accessTier- the accessTier value to set.- Returns:
- the FileShareProperties object itself.
-
accessTierChangeTime
public OffsetDateTime accessTierChangeTime()
Get the accessTierChangeTime property: Indicates the last modification time for share access tier.- Returns:
- the accessTierChangeTime value.
-
accessTierStatus
public String accessTierStatus()
Get the accessTierStatus property: Indicates if there is a pending transition for access tier.- Returns:
- the accessTierStatus value.
-
shareUsageBytes
public Long shareUsageBytes()
Get the shareUsageBytes property: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.- Returns:
- the shareUsageBytes value.
-
leaseStatus
public LeaseStatus leaseStatus()
Get the leaseStatus property: The lease status of the share.- Returns:
- the leaseStatus value.
-
leaseState
public LeaseState leaseState()
Get the leaseState property: Lease state of the share.- Returns:
- the leaseState value.
-
leaseDuration
public LeaseDuration leaseDuration()
Get the leaseDuration property: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.- Returns:
- the leaseDuration value.
-
signedIdentifiers
public List<SignedIdentifier> signedIdentifiers()
Get the signedIdentifiers property: List of stored access policies specified on the share.- Returns:
- the signedIdentifiers value.
-
withSignedIdentifiers
public FileShareProperties withSignedIdentifiers(List<SignedIdentifier> signedIdentifiers)
Set the signedIdentifiers property: List of stored access policies specified on the share.- Parameters:
signedIdentifiers- the signedIdentifiers value to set.- Returns:
- the FileShareProperties object itself.
-
snapshotTime
public OffsetDateTime snapshotTime()
Get the snapshotTime property: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".- Returns:
- the snapshotTime value.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
-