Package com.azure.storage.file.share.options

Class ShareCreateOptions

java.lang.Object
com.azure.storage.file.share.options.ShareCreateOptions
public class ShareCreateOptions extends Object
Extended options that may be passed when creating a share.

  • Constructor Details

    • ShareCreateOptions

      public ShareCreateOptions()
      Creates a new instance of ShareCreateOptions.

  • Method Details

    • getQuotaInGb

      public Integer getQuotaInGb()
      Gets the size in GB to limit the share's growth.
      Returns:
      Size in GB to limit the share's growth.

    • setQuotaInGb

      public ShareCreateOptions setQuotaInGb(Integer quotaInGb)
      Sets the size in GB to limit the share's growth.
      Parameters:
      quotaInGb - Size in GB to limit the share's growth. The quota in GB must be between 1 and 5120.
      Returns:
      The updated options.

    • getMetadata

      public Map<String,String> getMetadata()
      Gets the metadata to associate with the share.
      Returns:
      Metadata to associate with the share

    • setMetadata

      public ShareCreateOptions setMetadata(Map<String,String> metadata)
      Sets the metadata to associate with the share.
      Parameters:
      metadata - Metadata to associate with the share. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.
      Returns:
      The updated options.

    • getAccessTier

      public ShareAccessTier getAccessTier()
      Gets the access tier for the share.
      Returns:
      ShareAccessTier.

    • setAccessTier

      public ShareCreateOptions setAccessTier(ShareAccessTier accessTier)
      Sets the access tier for the share.
      Parameters:
      accessTier - ShareAccessTier.
      Returns:
      The updated options.

    • getProtocols

      public ShareProtocols getProtocols()
      Gets the protocols to enable on the share.
      Returns:
      ShareProtocols

    • setProtocols

      public ShareCreateOptions setProtocols(ShareProtocols protocols)
      Sets the protocols to enable on the share.
      Parameters:
      protocols - ShareProtocols
      Returns:
      The updated options.

    • getRootSquash

      public ShareRootSquash getRootSquash()
      Gets the root squash to set for the share. Only valid for NFS.
      Returns:
      The root squash to set for the share. Only valid for NFS.

    • setRootSquash

      public ShareCreateOptions setRootSquash(ShareRootSquash rootSquash)
      Sets the root squash to set for the share. Only valid for NFS.
      Parameters:
      rootSquash - The root squash to set for the share. Only valid for NFS.
      Returns:
      The updated options.

    • isSnapshotVirtualDirectoryAccessEnabled

      public Boolean isSnapshotVirtualDirectoryAccessEnabled()
      Get the enableSnapshotVirtualDirectoryAccess property: 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 ShareCreateOptions setSnapshotVirtualDirectoryAccessEnabled(Boolean snapshotVirtualDirectoryAccessEnabled)
      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:
      snapshotVirtualDirectoryAccessEnabled - the enableSnapshotVirtualDirectoryAccess value to set.
      Returns:
      the ShareCreateOptions 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 ShareCreateOptions 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 ShareCreateOptions 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 ShareCreateOptions 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 ShareCreateOptions 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 ShareCreateOptions 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 ShareCreateOptions object itself.

    • getProvisionedMaxIops

      public Long getProvisionedMaxIops()
      Get the provisionedMaxIops property: Optional. Only applicable to provisioned v2 storage accounts. The provisioned IOPS of the share. For SSD, minimum IOPS is 3,000 and maximum is 100,000. For HDD, minimum IOPS is 500 and maximum is 50,000.
      Returns:
      the provisionedMaxIops value.

    • setProvisionedMaxIops

      public ShareCreateOptions setProvisionedMaxIops(Long provisionedMaxIops)
      Set the provisionedMaxIops property: Optional. Only applicable to provisioned v2 storage accounts. The provisioned IOPS of the share. For SSD, minimum IOPS is 3,000 and maximum is 100,000. For HDD, minimum IOPS is 500 and maximum is 50,000.
      Parameters:
      provisionedMaxIops - the provisionedIops value to set.
      Returns:
      the ShareCreateOptions object itself.

    • getProvisionedMaxBandwidthMibps

      public Long getProvisionedMaxBandwidthMibps()
      Get the provisionedMaxBandwidthMibps property: Optional. Only applicable to provisioned v2 storage accounts. The provisioned throughput of the share. For SSD, minimum throughput is 125 MiB/sec and maximum is 10,340 MiB/sec. For HDD, minimum throughput is 60 MiB/sec and maximum is 5,125 MiB/sec.
      Returns:
      the provisionedMaxBandwidthMibps value.

    • setProvisionedMaxBandwidthMibps

      public ShareCreateOptions setProvisionedMaxBandwidthMibps(Long provisionedMaxBandwidthMibps)
      Set the provisionedMaxBandwidthMibps property: Optional. Only applicable to provisioned v2 storage accounts. The provisioned throughput of the share. For SSD, minimum throughput is 125 MiB/sec and maximum is 10,340 MiB/sec. For HDD, minimum throughput is 60 MiB/sec and maximum is 5,125 MiB/sec.
      Parameters:
      provisionedMaxBandwidthMibps - the provisionedMaxBandwidthMibps value to set.
      Returns:
      the ShareCreateOptions object itself.