Package com.azure.storage.file.share.models

Class ShareProperties

java.lang.Object
com.azure.storage.file.share.models.ShareProperties
All Implemented Interfaces:
com.azure.xml.XmlSerializable<ShareProperties>
public final class ShareProperties extends Object implements com.azure.xml.XmlSerializable<ShareProperties>
Properties of a share.

  • Constructor Details

    • ShareProperties

      public ShareProperties()
      Creates a new instance of ShareProperties.

  • Method Details

    • getLastModified

      public OffsetDateTime getLastModified()
      Get the lastModified property: The lastModified property.
      Returns:
      the lastModified value.

    • 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.

    • getETag

      public String getETag()
      Get the eTag property: The eTag property.
      Returns:
      the eTag value.

    • 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.

    • getQuota

      public int getQuota()
      Get the quota property: The quota property.
      Returns:
      the quota value.

    • 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.

    • getProvisionedIops

      public Integer getProvisionedIops()
      Get the provisionedIops property: The provisionedIops property.
      Returns:
      the provisionedIops value.

    • 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.

    • getProvisionedIngressMBps

      @Deprecated public Integer getProvisionedIngressMBps()
      Deprecated.
      Please use getProvisionedBandwidthMiBps()
      Get the provisionedIngressMBps property: The provisionedIngressMBps property.
      Returns:
      the provisionedIngressMBps value.

    • setProvisionedIngressMBps

      @Deprecated public ShareProperties setProvisionedIngressMBps(Integer provisionedIngressMBps)
      Deprecated.
      Please use setProvisionedBandwidthMiBps(Integer) ()}
      Set the provisionedIngressMBps property: The provisionedIngressMBps property.
      Parameters:
      provisionedIngressMBps - the provisionedIngressMBps value to set.
      Returns:
      the ShareProperties object itself.

    • getProvisionedEgressMBps

      @Deprecated public Integer getProvisionedEgressMBps()
      Deprecated.
      Please use getProvisionedBandwidthMiBps()
      Get the provisionedEgressMBps property: The provisionedEgressMBps property.
      Returns:
      the provisionedEgressMBps value.

    • setProvisionedEgressMBps

      @Deprecated public ShareProperties setProvisionedEgressMBps(Integer provisionedEgressMBps)
      Deprecated.
      Please use setProvisionedBandwidthMiBps(Integer) ()}
      Set the provisionedEgressMBps property: The provisionedEgressMBps property.
      Parameters:
      provisionedEgressMBps - the provisionedEgressMBps value to set.
      Returns:
      the ShareProperties object itself.

    • getProvisionedBandwidthMiBps

      public Integer getProvisionedBandwidthMiBps()
      Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
      Returns:
      the provisionedBandwidthMiBps value.

    • 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.

    • getNextAllowedQuotaDowngradeTime

      public OffsetDateTime getNextAllowedQuotaDowngradeTime()
      Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
      Returns:
      the nextAllowedQuotaDowngradeTime value.

    • 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.

    • getDeletedTime

      public OffsetDateTime getDeletedTime()
      Get the deletedTime property: The deletedTime property.
      Returns:
      the deletedTime value.

    • 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.

    • getRemainingRetentionDays

      public Integer getRemainingRetentionDays()
      Get the remainingRetentionDays property: The remainingRetentionDays property.
      Returns:
      the remainingRetentionDays value.

    • 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.

    • getAccessTier

      public String getAccessTier()
      Get the accessTier property: The accessTier property.
      Returns:
      the accessTier 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.

    • getAccessTierChangeTime

      public OffsetDateTime getAccessTierChangeTime()
      Get the accessTierChangeTime property: The accessTierChangeTime property.
      Returns:
      the accessTierChangeTime value.

    • 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.

    • getAccessTierTransitionState

      public String getAccessTierTransitionState()
      Get the accessTierTransitionState property: The accessTierTransitionState property.
      Returns:
      the accessTierTransitionState value.

    • 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.

    • getLeaseStatus

      public LeaseStatusType getLeaseStatus()
      Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.
      Returns:
      the leaseStatus value.

    • 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.

    • getLeaseState

      public LeaseStateType getLeaseState()
      Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
      Returns:
      the leaseState value.

    • 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.

    • getLeaseDuration

      public LeaseDurationType getLeaseDuration()
      Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.
      Returns:
      the leaseDuration value.

    • 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.

    • getProtocols

      public ShareProtocols getProtocols()
      Get the enabledProtocols property: The enabledProtocols property.
      Returns:
      the enabledProtocols value.

    • 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.

    • getRootSquash

      public ShareRootSquash getRootSquash()
      Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
      Returns:
      the rootSquash value.

    • 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.

    • getMetadata

      public Map<String,String> getMetadata()
      Get the metadata property: The metadata property.
      Returns:
      the metadata value.

    • setMetadata

      public ShareProperties setMetadata(Map<String,String> metadata)
      Set the metadata property: The metadata property.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the ShareProperties object itself.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<ShareProperties>
      Throws:
      XMLStreamException

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<ShareProperties>
      Throws:
      XMLStreamException

    • fromXml

      public static ShareProperties fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      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:
      IllegalStateException - If the deserialized XML object was missing any required properties.
      XMLStreamException - If an error occurs while reading the ShareProperties.

    • fromXml

      public static ShareProperties fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      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:
      IllegalStateException - If the deserialized XML object was missing any required properties.
      XMLStreamException - If an error occurs while reading the ShareProperties.