ShareProperties Class

Package:

com.azure.storage.file.share.models

Maven Artifact:

com.azure:azure-storage-file-share:12.25.1

• java.lang.Object
• • com.azure.storage.file.share.models.ShareProperties

Implements

XmlSerializable<ShareProperties>

public final class ShareProperties
implements XmlSerializable<ShareProperties>

Properties of a share.

Constructor Summary

Constructor	Description
ShareProperties()

Method Summary

Modifier and Type	Method and Description
static ShareProperties	fromXml(XmlReader xmlReader) Reads an instance of ShareProperties from the XmlReader.
static ShareProperties	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of ShareProperties from the XmlReader.
String	getAccessTier() Get the accessTier property: The accessTier property.
OffsetDateTime	getAccessTierChangeTime() Get the accessTierChangeTime property: The accessTierChangeTime property.
String	getAccessTierTransitionState() Get the accessTierTransitionState property: The accessTierTransitionState property.
OffsetDateTime	getDeletedTime() Get the deletedTime property: The deletedTime property.
String	getETag() Get the eTag property: The eTag property.
Long	getIncludedBurstIops() Get the includedBurstIops property.
OffsetDateTime	getLastModified() Get the lastModified property: The lastModified property.
LeaseDurationType	getLeaseDuration() Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.
LeaseStateType	getLeaseState() Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
LeaseStatusType	getLeaseStatus() Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.
Long	getMaxBurstCreditsForIops() Get the maxBurstCreditsForIops property.
Map<String,String>	getMetadata() Get the metadata property: The metadata property.
OffsetDateTime	getNextAllowedProvisionedBandwidthDowngradeTime() Get the nextAllowedProvisionedBandwidthDowngradeTime property.
OffsetDateTime	getNextAllowedProvisionedIopsDowngradeTime() Get the nextAllowedProvisionedIopsDowngradeTime property.
OffsetDateTime	getNextAllowedQuotaDowngradeTime() Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
Long	getPaidBurstingMaxBandwidthMibps() Get the paidBurstingMaxBandwidthMibps property: Optional.
Long	getPaidBurstingMaxIops() Get the paidBurstingMaxIops property: Optional.
ShareProtocols	getProtocols() Get the enabledProtocols property: The enabledProtocols property.
Integer	getProvisionedBandwidthMiBps() Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
Integer	getProvisionedEgressMBps() Deprecated Please use getProvisionedBandwidthMiBps() Get the provisionedEgressMBps property: The provisionedEgressMBps property.
Integer	getProvisionedIngressMBps() Deprecated Please use getProvisionedBandwidthMiBps() Get the provisionedIngressMBps property: The provisionedIngressMBps property.
Integer	getProvisionedIops() Get the provisionedIops property: The provisionedIops property.
int	getQuota() Get the quota property: The quota property.
Integer	getRemainingRetentionDays() Get the remainingRetentionDays property: The remainingRetentionDays property.
ShareRootSquash	getRootSquash() Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Boolean	isPaidBurstingEnabled() Get the enablePaidBursting property: Optional.
Boolean	isSnapshotVirtualDirectoryAccessEnabled() Get the enableSnapshotVirtualDirectoryAccess property: Optional.
ShareProperties	setAccessTier(String accessTier) Set the accessTier property: The accessTier property.
ShareProperties	setAccessTierChangeTime(OffsetDateTime accessTierChangeTime) Set the accessTierChangeTime property: The accessTierChangeTime property.
ShareProperties	setAccessTierTransitionState(String accessTierTransitionState) Set the accessTierTransitionState property: The accessTierTransitionState property.
ShareProperties	setDeletedTime(OffsetDateTime deletedTime) Set the deletedTime property: The deletedTime property.
ShareProperties	setETag(String eTag) Set the eTag property: The eTag property.
ShareProperties	setIncludedBurstIops(Long includedBurstIops) Set the includedBurstIops property.
ShareProperties	setLastModified(OffsetDateTime lastModified) Set the lastModified property: The lastModified property.
ShareProperties	setLeaseDuration(LeaseDurationType leaseDuration) Set the leaseDuration property: Possible values include: 'infinite', 'fixed'.
ShareProperties	setLeaseState(LeaseStateType leaseState) Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
ShareProperties	setLeaseStatus(LeaseStatusType leaseStatus) Set the leaseStatus property: Possible values include: 'locked', 'unlocked'.
ShareProperties	setMaxBurstCreditsForIops(Long maxBurstCreditsForIops) Set the maxBurstCreditsForIops property.
ShareProperties	setMetadata(Map<String,String> metadata) Set the metadata property: The metadata property.
ShareProperties	setNextAllowedProvisionedBandwidthDowngradeTime(OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime) Set the nextAllowedProvisionedBandwidthDowngradeTime property.
ShareProperties	setNextAllowedProvisionedIopsDowngradeTime(OffsetDateTime nextAllowedProvisionedIopsDowngradeTime) Set the nextAllowedProvisionedIopsDowngradeTime property.
ShareProperties	setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime) Set the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
ShareProperties	setPaidBurstingEnabled(Boolean enablePaidBursting) Set the enablePaidBursting property: Optional.
ShareProperties	setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps) Set the paidBurstingMaxBandwidthMibps property: Optional.
ShareProperties	setPaidBurstingMaxIops(Long paidBurstingMaxIops) Set the paidBurstingMaxIops property: Optional.
ShareProperties	setProtocols(ShareProtocols protocols) Set the enabledProtocols property: The enabledProtocols property.
ShareProperties	setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) Set the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
ShareProperties	setProvisionedEgressMBps(Integer provisionedEgressMBps) Deprecated Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()} Set the provisionedEgressMBps property: The provisionedEgressMBps property.
ShareProperties	setProvisionedIngressMBps(Integer provisionedIngressMBps) Deprecated Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()} Set the provisionedIngressMBps property: The provisionedIngressMBps property.
ShareProperties	setProvisionedIops(Integer provisionedIops) Set the provisionedIops property: The provisionedIops property.
ShareProperties	setQuota(int quota) Set the quota property: The quota property.
ShareProperties	setRemainingRetentionDays(Integer remainingRetentionDays) Set the remainingRetentionDays property: The remainingRetentionDays property.
ShareProperties	setRootSquash(ShareRootSquash rootSquash) Set the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
ShareProperties	setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess) Set the enableSnapshotVirtualDirectoryAccess property: Optional.
XmlWriter	toXml(XmlWriter xmlWriter)
XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareProperties

public ShareProperties()

Method Details

fromXml

public static ShareProperties fromXml(XmlReader xmlReader)

Reads an instance of ShareProperties from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of ShareProperties if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

fromXml

public static ShareProperties fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of ShareProperties from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.

Returns:

An instance of ShareProperties if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

getAccessTier

public String getAccessTier()

Get the accessTier property: The accessTier property.

Returns:

the accessTier value.

getAccessTierChangeTime

public OffsetDateTime getAccessTierChangeTime()

Get the accessTierChangeTime property: The accessTierChangeTime property.

Returns:

the accessTierChangeTime value.

getAccessTierTransitionState

public String getAccessTierTransitionState()

Get the accessTierTransitionState property: The accessTierTransitionState property.

Returns:

the accessTierTransitionState value.

getDeletedTime

public OffsetDateTime getDeletedTime()

Get the deletedTime property: The deletedTime property.

Returns:

the deletedTime value.

getETag

public String getETag()

Get the eTag property: The eTag property.

Returns:

the eTag value.

getIncludedBurstIops

public Long getIncludedBurstIops()

Get the includedBurstIops property. Only applicable to provisioned v2 storage accounts. The calculated burst IOPS of the share.

Returns:

the includedBurstIops value itself.

getLastModified

public OffsetDateTime getLastModified()

Get the lastModified property: The lastModified property.

Returns:

the lastModified value.

getLeaseDuration

public LeaseDurationType getLeaseDuration()

Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.

Returns:

the leaseDuration value.

getLeaseState

public LeaseStateType getLeaseState()

Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

Returns:

the leaseState value.

getLeaseStatus

public LeaseStatusType getLeaseStatus()

Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.

Returns:

the leaseStatus value.

getMaxBurstCreditsForIops

public Long getMaxBurstCreditsForIops()

Get the maxBurstCreditsForIops property. Only applicable to provisioned v2 storage accounts. The calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.

Returns:

the maxBurstCreditsForIops value itself.

getMetadata

public Map getMetadata()

Get the metadata property: The metadata property.

Returns:

the metadata value.

getNextAllowedProvisionedBandwidthDowngradeTime

public OffsetDateTime getNextAllowedProvisionedBandwidthDowngradeTime()

Get the nextAllowedProvisionedBandwidthDowngradeTime property. Only applicable to provisioned v2 storage accounts. The time the share can be downgraded to lower provisioned bandwidth.

Returns:

the nextAllowedProvisionedBandwidthDowngradeTime value itself.

getNextAllowedProvisionedIopsDowngradeTime

public OffsetDateTime getNextAllowedProvisionedIopsDowngradeTime()

Get the nextAllowedProvisionedIopsDowngradeTime property. Only applicable to provisioned v2 storage accounts. The time the share can be downgraded to lower provisioned IOPs.

Returns:

the nextAllowedProvisionedIopsDowngradeTime value itself.

getNextAllowedQuotaDowngradeTime

public OffsetDateTime getNextAllowedQuotaDowngradeTime()

Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.

Returns:

the nextAllowedQuotaDowngradeTime value.

getPaidBurstingMaxBandwidthMibps

public Long getPaidBurstingMaxBandwidthMibps()

Get the paidBurstingMaxBandwidthMibps property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.

Returns:

the paidBurstingMaxBandwidthMibps value.

getPaidBurstingMaxIops

public Long getPaidBurstingMaxIops()

Get the paidBurstingMaxIops property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.

Returns:

the paidBurstingMaxIops value.

getProtocols

public ShareProtocols getProtocols()

Get the enabledProtocols property: The enabledProtocols property.

Returns:

the enabledProtocols value.

getProvisionedBandwidthMiBps

public Integer getProvisionedBandwidthMiBps()

Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.

Returns:

the provisionedBandwidthMiBps value.

getProvisionedEgressMBps

@Deprecated
public Integer getProvisionedEgressMBps()

Deprecated

Please use getProvisionedBandwidthMiBps()

Get the provisionedEgressMBps property: The provisionedEgressMBps property.

Returns:

the provisionedEgressMBps value.

getProvisionedIngressMBps

@Deprecated
public Integer getProvisionedIngressMBps()

Deprecated

Please use getProvisionedBandwidthMiBps()

Get the provisionedIngressMBps property: The provisionedIngressMBps property.

Returns:

the provisionedIngressMBps value.

getProvisionedIops

public Integer getProvisionedIops()

Get the provisionedIops property: The provisionedIops property.

Returns:

the provisionedIops value.

getQuota

public int getQuota()

Get the quota property: The quota property.

Returns:

the quota value.

getRemainingRetentionDays

public Integer getRemainingRetentionDays()

Get the remainingRetentionDays property: The remainingRetentionDays property.

Returns:

the remainingRetentionDays value.

getRootSquash

public ShareRootSquash getRootSquash()

Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Returns:

the rootSquash value.

isPaidBurstingEnabled

public Boolean isPaidBurstingEnabled()

Get the enablePaidBursting property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. This property enables paid bursting on premium file storage accounts.

Returns:

the enablePaidBursting value.

isSnapshotVirtualDirectoryAccessEnabled

public Boolean isSnapshotVirtualDirectoryAccessEnabled()

Get the enableSnapshotVirtualDirectoryAccess property: Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true.

Returns:

the enableSnapshotVirtualDirectoryAccess value.

setAccessTier

public ShareProperties setAccessTier(String accessTier)

Set the accessTier property: The accessTier property.

Parameters:

accessTier - the accessTier value to set.

Returns:

the ShareProperties object itself.

setAccessTierChangeTime

public ShareProperties setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)

Set the accessTierChangeTime property: The accessTierChangeTime property.

Parameters:

accessTierChangeTime - the accessTierChangeTime value to set.

Returns:

the ShareProperties object itself.

setAccessTierTransitionState

public ShareProperties setAccessTierTransitionState(String accessTierTransitionState)

Set the accessTierTransitionState property: The accessTierTransitionState property.

Parameters:

accessTierTransitionState - the accessTierTransitionState value to set.

Returns:

the ShareProperties object itself.

setDeletedTime

public ShareProperties setDeletedTime(OffsetDateTime deletedTime)

Set the deletedTime property: The deletedTime property.

Parameters:

deletedTime - the deletedTime value to set.

Returns:

the ShareProperties object itself.

setETag

public ShareProperties setETag(String eTag)

Set the eTag property: The eTag property.

Parameters:

eTag - the eTag value to set.

Returns:

the ShareProperties object itself.

setIncludedBurstIops

public ShareProperties setIncludedBurstIops(Long includedBurstIops)

Set the includedBurstIops property. Only applicable to provisioned v2 storage accounts. The calculated burst IOPS of the share.

Parameters:

includedBurstIops - the includedBurstIops value to set.

Returns:

the ShareProperties object itself.

setLastModified

public ShareProperties setLastModified(OffsetDateTime lastModified)

Set the lastModified property: The lastModified property.

Parameters:

lastModified - the lastModified value to set.

Returns:

the ShareProperties object itself.

setLeaseDuration

public ShareProperties setLeaseDuration(LeaseDurationType leaseDuration)

Set the leaseDuration property: Possible values include: 'infinite', 'fixed'.

Parameters:

leaseDuration - the leaseDuration value to set.

Returns:

the ShareProperties object itself.

setLeaseState

public ShareProperties setLeaseState(LeaseStateType leaseState)

Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

Parameters:

leaseState - the leaseState value to set.

Returns:

the ShareProperties object itself.

setLeaseStatus

public ShareProperties setLeaseStatus(LeaseStatusType leaseStatus)

Set the leaseStatus property: Possible values include: 'locked', 'unlocked'.

Parameters:

leaseStatus - the leaseStatus value to set.

Returns:

the ShareProperties object itself.

setMaxBurstCreditsForIops

public ShareProperties setMaxBurstCreditsForIops(Long maxBurstCreditsForIops)

Set the maxBurstCreditsForIops property. Only applicable to provisioned v2 storage accounts. The calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.

Parameters:

maxBurstCreditsForIops - the maxBurstCreditsForIops value to set.

Returns:

the ShareProperties object itself.

setMetadata

public ShareProperties setMetadata(Map metadata)

Set the metadata property: The metadata property.

Parameters:

metadata - the metadata value to set.

Returns:

the ShareProperties object itself.

setNextAllowedProvisionedBandwidthDowngradeTime

public ShareProperties setNextAllowedProvisionedBandwidthDowngradeTime(OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime)

Set the nextAllowedProvisionedBandwidthDowngradeTime property. Only applicable to provisioned v2 storage accounts. The time the share can be downgraded to lower provisioned bandwidth.

Parameters:

nextAllowedProvisionedBandwidthDowngradeTime - the nextAllowedProvisionedBandwidthDowngradeTime value to set.

Returns:

the ShareProperties object itself.

setNextAllowedProvisionedIopsDowngradeTime

public ShareProperties setNextAllowedProvisionedIopsDowngradeTime(OffsetDateTime nextAllowedProvisionedIopsDowngradeTime)

Set the nextAllowedProvisionedIopsDowngradeTime property. Only applicable to provisioned v2 storage accounts. The time the share can be downgraded to lower provisioned IOPs.

Parameters:

nextAllowedProvisionedIopsDowngradeTime - the nextAllowedProvisionedIopsDowngradeTime value to set.

Returns:

the ShareProperties object itself.

setNextAllowedQuotaDowngradeTime

public ShareProperties setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)

Set the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.

Parameters:

nextAllowedQuotaDowngradeTime - the nextAllowedQuotaDowngradeTime value to set.

Returns:

the ShareProperties object itself.

setPaidBurstingEnabled

public ShareProperties setPaidBurstingEnabled(Boolean enablePaidBursting)

Set the enablePaidBursting property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. This property enables paid bursting on premium file storage accounts.

Parameters:

enablePaidBursting - the enablePaidBursting value to set.

Returns:

the ShareSetPropertiesOptions object itself.

setPaidBurstingMaxBandwidthMibps

public ShareProperties setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)

Set the paidBurstingMaxBandwidthMibps property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.

Parameters:

paidBurstingMaxBandwidthMibps - the paidBurstingMaxBandwidthMibps value to set.

Returns:

the ShareSetPropertiesOptions object itself.

setPaidBurstingMaxIops

public ShareProperties setPaidBurstingMaxIops(Long paidBurstingMaxIops)

Set the paidBurstingMaxIops property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.

Parameters:

paidBurstingMaxIops - the paidBurstingMaxIops value to set.

Returns:

the ShareSetPropertiesOptions object itself.

setProtocols

public ShareProperties setProtocols(ShareProtocols protocols)

Set the enabledProtocols property: The enabledProtocols property.

Parameters:

protocols - the enabledProtocols value to set.

Returns:

the ShareProperties object itself.

setProvisionedBandwidthMiBps

public ShareProperties setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)

Set the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.

Parameters:

provisionedBandwidthMiBps - the provisionedBandwidthMiBps value to set.

Returns:

the ShareProperties object itself.

setProvisionedEgressMBps

@Deprecated
public ShareProperties setProvisionedEgressMBps(Integer provisionedEgressMBps)

Deprecated

Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()}

Set the provisionedEgressMBps property: The provisionedEgressMBps property.

Parameters:

provisionedEgressMBps - the provisionedEgressMBps value to set.

Returns:

the ShareProperties object itself.

setProvisionedIngressMBps

@Deprecated
public ShareProperties setProvisionedIngressMBps(Integer provisionedIngressMBps)

Deprecated

Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()}

Set the provisionedIngressMBps property: The provisionedIngressMBps property.

Parameters:

provisionedIngressMBps - the provisionedIngressMBps value to set.

Returns:

the ShareProperties object itself.

setProvisionedIops

public ShareProperties setProvisionedIops(Integer provisionedIops)

Set the provisionedIops property: The provisionedIops property.

Parameters:

provisionedIops - the provisionedIops value to set.

Returns:

the ShareProperties object itself.

setQuota

public ShareProperties setQuota(int quota)

Set the quota property: The quota property.

Parameters:

quota - the quota value to set.

Returns:

the ShareProperties object itself.

setRemainingRetentionDays

public ShareProperties setRemainingRetentionDays(Integer remainingRetentionDays)

Set the remainingRetentionDays property: The remainingRetentionDays property.

Parameters:

remainingRetentionDays - the remainingRetentionDays value to set.

Returns:

the ShareProperties object itself.

setRootSquash

public ShareProperties setRootSquash(ShareRootSquash rootSquash)

Set the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Parameters:

rootSquash - the rootSquash value to set.

Returns:

the ShareProperties object itself.

setSnapshotVirtualDirectoryAccessEnabled

public ShareProperties setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)

Set the enableSnapshotVirtualDirectoryAccess property: Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true.

Parameters:

enableSnapshotVirtualDirectoryAccess - the enableSnapshotVirtualDirectoryAccess value to set.

Returns:

the ShareProperties object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException