ShareProperties Class
- java.
lang. Object - com.
azure. storage. file. share. models. ShareProperties
- com.
Implements
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
Share |
fromXml(XmlReader xmlReader)
Reads an instance of Share |
static
Share |
fromXml(XmlReader xmlReader, String rootElementName)
Reads an instance of Share |
String |
getAccessTier()
Get the access |
Offset |
getAccessTierChangeTime()
Get the access |
String |
getAccessTierTransitionState()
Get the access |
Offset |
getDeletedTime()
Get the deleted |
String |
getETag()
Get the e |
Offset |
getLastModified()
Get the last |
Lease |
getLeaseDuration()
Get the lease |
Lease |
getLeaseState()
Get the lease |
Lease |
getLeaseStatus()
Get the lease |
Map<String,String> |
getMetadata()
Get the metadata property: The metadata property. |
Offset |
getNextAllowedQuotaDowngradeTime()
Get the next |
Long |
getPaidBurstingMaxBandwidthMibps()
Get the paid |
Long |
getPaidBurstingMaxIops()
Get the paid |
Share |
getProtocols()
Get the enabled |
Integer |
getProvisionedBandwidthMiBps()
Get the provisioned |
Integer |
getProvisionedEgressMBps()
Deprecated
Please use getProvisionedBandwidthMiBps()
Get the provisioned |
Integer |
getProvisionedIngressMBps()
Deprecated
Please use getProvisionedBandwidthMiBps()
Get the provisioned |
Integer |
getProvisionedIops()
Get the provisioned |
int |
getQuota()
Get the quota property: The quota property. |
Integer |
getRemainingRetentionDays()
Get the remaining |
Share |
getRootSquash()
Get the root |
Boolean |
isPaidBurstingEnabled()
Get the enable |
Boolean |
isSnapshotVirtualDirectoryAccessEnabled()
Get the enable |
Share |
setAccessTier(String accessTier)
Set the access |
Share |
setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)
Set the access |
Share |
setAccessTierTransitionState(String accessTierTransitionState)
Set the access |
Share |
setDeletedTime(OffsetDateTime deletedTime)
Set the deleted |
Share |
setETag(String eTag)
Set the e |
Share |
setLastModified(OffsetDateTime lastModified)
Set the last |
Share |
setLeaseDuration(LeaseDurationType leaseDuration)
Set the lease |
Share |
setLeaseState(LeaseStateType leaseState)
Set the lease |
Share |
setLeaseStatus(LeaseStatusType leaseStatus)
Set the lease |
Share |
setMetadata(Map<String,String> metadata)
Set the metadata property: The metadata property. |
Share |
setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)
Set the next |
Share |
setPaidBurstingEnabled(Boolean enablePaidBursting)
Set the enable |
Share |
setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)
Set the paid |
Share |
setPaidBurstingMaxIops(Long paidBurstingMaxIops)
Set the paid |
Share |
setProtocols(ShareProtocols protocols)
Set the enabled |
Share |
setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)
Set the provisioned |
Share |
setProvisionedEgressMBps(Integer provisionedEgressMBps)
Deprecated Set the provisioned |
Share |
setProvisionedIngressMBps(Integer provisionedIngressMBps)
Deprecated Set the provisioned |
Share |
setProvisionedIops(Integer provisionedIops)
Set the provisioned |
Share |
setQuota(int quota)
Set the quota property: The quota property. |
Share |
setRemainingRetentionDays(Integer remainingRetentionDays)
Set the remaining |
Share |
setRootSquash(ShareRootSquash rootSquash)
Set the root |
Share |
setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)
Set the enable |
Xml |
toXml(XmlWriter xmlWriter) |
Xml |
toXml(XmlWriter xmlWriter, String rootElementName) |
Methods inherited from java.lang.Object
Constructor Details
ShareProperties
public ShareProperties()
Method Details
fromXml
public static ShareProperties fromXml(XmlReader xmlReader)
Reads an instance of ShareProperties from the XmlReader.
Parameters:
Returns:
Throws:
fromXml
public static ShareProperties fromXml(XmlReader xmlReader, String rootElementName)
Reads an instance of ShareProperties from the XmlReader.
Parameters:
Returns:
Throws:
getAccessTier
public String getAccessTier()
Get the accessTier property: The accessTier property.
Returns:
getAccessTierChangeTime
public OffsetDateTime getAccessTierChangeTime()
Get the accessTierChangeTime property: The accessTierChangeTime property.
Returns:
getAccessTierTransitionState
public String getAccessTierTransitionState()
Get the accessTierTransitionState property: The accessTierTransitionState property.
Returns:
getDeletedTime
public OffsetDateTime getDeletedTime()
Get the deletedTime property: The deletedTime property.
Returns:
getETag
public String getETag()
Get the eTag property: The eTag property.
Returns:
getLastModified
public OffsetDateTime getLastModified()
Get the lastModified property: The lastModified property.
Returns:
getLeaseDuration
public LeaseDurationType getLeaseDuration()
Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.
Returns:
getLeaseState
public LeaseStateType getLeaseState()
Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
Returns:
getLeaseStatus
public LeaseStatusType getLeaseStatus()
Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.
Returns:
getMetadata
public Map
Get the metadata property: The metadata property.
Returns:
getNextAllowedQuotaDowngradeTime
public OffsetDateTime getNextAllowedQuotaDowngradeTime()
Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
Returns:
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:
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:
getProtocols
public ShareProtocols getProtocols()
Get the enabledProtocols property: The enabledProtocols property.
Returns:
getProvisionedBandwidthMiBps
public Integer getProvisionedBandwidthMiBps()
Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
Returns:
getProvisionedEgressMBps
@Deprecated
public Integer getProvisionedEgressMBps()
Deprecated
Get the provisionedEgressMBps property: The provisionedEgressMBps property.
Returns:
getProvisionedIngressMBps
@Deprecated
public Integer getProvisionedIngressMBps()
Deprecated
Get the provisionedIngressMBps property: The provisionedIngressMBps property.
Returns:
getProvisionedIops
public Integer getProvisionedIops()
Get the provisionedIops property: The provisionedIops property.
Returns:
getQuota
public int getQuota()
Get the quota property: The quota property.
Returns:
getRemainingRetentionDays
public Integer getRemainingRetentionDays()
Get the remainingRetentionDays property: The remainingRetentionDays property.
Returns:
getRootSquash
public ShareRootSquash getRootSquash()
Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Returns:
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:
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:
setAccessTier
public ShareProperties setAccessTier(String accessTier)
Set the accessTier property: The accessTier property.
Parameters:
Returns:
setAccessTierChangeTime
public ShareProperties setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)
Set the accessTierChangeTime property: The accessTierChangeTime property.
Parameters:
Returns:
setAccessTierTransitionState
public ShareProperties setAccessTierTransitionState(String accessTierTransitionState)
Set the accessTierTransitionState property: The accessTierTransitionState property.
Parameters:
Returns:
setDeletedTime
public ShareProperties setDeletedTime(OffsetDateTime deletedTime)
Set the deletedTime property: The deletedTime property.
Parameters:
Returns:
setETag
public ShareProperties setETag(String eTag)
Set the eTag property: The eTag property.
Parameters:
Returns:
setLastModified
public ShareProperties setLastModified(OffsetDateTime lastModified)
Set the lastModified property: The lastModified property.
Parameters:
Returns:
setLeaseDuration
public ShareProperties setLeaseDuration(LeaseDurationType leaseDuration)
Set the leaseDuration property: Possible values include: 'infinite', 'fixed'.
Parameters:
Returns:
setLeaseState
public ShareProperties setLeaseState(LeaseStateType leaseState)
Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
Parameters:
Returns:
setLeaseStatus
public ShareProperties setLeaseStatus(LeaseStatusType leaseStatus)
Set the leaseStatus property: Possible values include: 'locked', 'unlocked'.
Parameters:
Returns:
setMetadata
public ShareProperties setMetadata(Map
Set the metadata property: The metadata property.
Parameters:
Returns:
setNextAllowedQuotaDowngradeTime
public ShareProperties setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)
Set the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
setProtocols
public ShareProperties setProtocols(ShareProtocols protocols)
Set the enabledProtocols property: The enabledProtocols property.
Parameters:
Returns:
setProvisionedBandwidthMiBps
public ShareProperties setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)
Set the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
Parameters:
Returns:
setProvisionedEgressMBps
@Deprecated
public ShareProperties setProvisionedEgressMBps(Integer provisionedEgressMBps)
Deprecated
Set the provisionedEgressMBps property: The provisionedEgressMBps property.
Parameters:
Returns:
setProvisionedIngressMBps
@Deprecated
public ShareProperties setProvisionedIngressMBps(Integer provisionedIngressMBps)
Deprecated
Set the provisionedIngressMBps property: The provisionedIngressMBps property.
Parameters:
Returns:
setProvisionedIops
public ShareProperties setProvisionedIops(Integer provisionedIops)
Set the provisionedIops property: The provisionedIops property.
Parameters:
Returns:
setQuota
public ShareProperties setQuota(int quota)
Set the quota property: The quota property.
Parameters:
Returns:
setRemainingRetentionDays
public ShareProperties setRemainingRetentionDays(Integer remainingRetentionDays)
Set the remainingRetentionDays property: The remainingRetentionDays property.
Parameters:
Returns:
setRootSquash
public ShareProperties setRootSquash(ShareRootSquash rootSquash)
Set the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Parameters:
Returns:
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:
Returns:
toXml
toXml
public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)
Parameters:
Throws:
Applies to
Azure SDK for Java