Package com.azure.resourcemanager.storage.fluent.models

Class FileShareProperties

java.lang.Object
com.azure.resourcemanager.storage.fluent.models.FileShareProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<FileShareProperties>
public final class FileShareProperties extends Object implements com.azure.json.JsonSerializable<FileShareProperties>
The properties of the file share.

  • Constructor Details

    • FileShareProperties

      public FileShareProperties()
      Creates an instance of FileShareProperties class.

  • Method Details

    • 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 provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.
      Returns:
      the shareQuota value.

    • withShareQuota

      public FileShareProperties withShareQuota(Integer shareQuota)
      Set the shareQuota property: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.
      Parameters:
      shareQuota - the shareQuota value to set.
      Returns:
      the FileShareProperties object itself.

    • provisionedIops

      public Integer provisionedIops()
      Get the provisionedIops property: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.
      Returns:
      the provisionedIops value.

    • withProvisionedIops

      public FileShareProperties withProvisionedIops(Integer provisionedIops)
      Set the provisionedIops property: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.
      Parameters:
      provisionedIops - the provisionedIops value to set.
      Returns:
      the FileShareProperties object itself.

    • provisionedBandwidthMibps

      public Integer provisionedBandwidthMibps()
      Get the provisionedBandwidthMibps property: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.
      Returns:
      the provisionedBandwidthMibps value.

    • withProvisionedBandwidthMibps

      public FileShareProperties withProvisionedBandwidthMibps(Integer provisionedBandwidthMibps)
      Set the provisionedBandwidthMibps property: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.
      Parameters:
      provisionedBandwidthMibps - the provisionedBandwidthMibps value to set.
      Returns:
      the FileShareProperties object itself.

    • includedBurstIops

      public Integer includedBurstIops()
      Get the includedBurstIops property: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
      Returns:
      the includedBurstIops value.

    • maxBurstCreditsForIops

      public Long maxBurstCreditsForIops()
      Get the maxBurstCreditsForIops property: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
      Returns:
      the maxBurstCreditsForIops value.

    • nextAllowedQuotaDowngradeTime

      public OffsetDateTime nextAllowedQuotaDowngradeTime()
      Get the nextAllowedQuotaDowngradeTime property: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type.
      Returns:
      the nextAllowedQuotaDowngradeTime value.

    • nextAllowedProvisionedIopsDowngradeTime

      public OffsetDateTime nextAllowedProvisionedIopsDowngradeTime()
      Get the nextAllowedProvisionedIopsDowngradeTime property: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.
      Returns:
      the nextAllowedProvisionedIopsDowngradeTime value.

    • nextAllowedProvisionedBandwidthDowngradeTime

      public OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime()
      Get the nextAllowedProvisionedBandwidthDowngradeTime property: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.
      Returns:
      the nextAllowedProvisionedBandwidthDowngradeTime value.

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

    • fileSharePaidBursting

      public FileSharePropertiesFileSharePaidBursting fileSharePaidBursting()
      Get the fileSharePaidBursting property: File Share Paid Bursting properties.
      Returns:
      the fileSharePaidBursting value.

    • withFileSharePaidBursting

      public FileShareProperties withFileSharePaidBursting(FileSharePropertiesFileSharePaidBursting fileSharePaidBursting)
      Set the fileSharePaidBursting property: File Share Paid Bursting properties.
      Parameters:
      fileSharePaidBursting - the fileSharePaidBursting value to set.
      Returns:
      the FileShareProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<FileShareProperties>
      Throws:
      IOException

    • fromJson

      public static FileShareProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FileShareProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FileShareProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the FileShareProperties.