ShareCreateOptions Class

  • Reference
Package:
com.azure.storage.file.share.options
Maven Artifact:
com.azure:azure-storage-file-share:12.25.0
  • java.lang.Object
    • com.azure.storage.file.share.options.ShareCreateOptions

public class ShareCreateOptions

Extended options that may be passed when creating a share.

Constructor Summary

Constructor Description
ShareCreateOptions()

Creates a new instance of ShareCreateOptions.

Method Summary

Modifier and Type Method and Description
ShareAccessTier getAccessTier()

Gets the access tier for the share.
Map<String,String> getMetadata()

Gets the metadata to associate with the share.
Long getPaidBurstingMaxBandwidthMibps()

Get the paidBurstingMaxBandwidthMibps property: Optional.
Long getPaidBurstingMaxIops()

Get the paidBurstingMaxIops property: Optional.
ShareProtocols getProtocols()

Gets the protocols to enable on the share.
Long getProvisionedMaxBandwidthMibps()

Get the provisionedMaxBandwidthMibps property: Optional.
Long getProvisionedMaxIops()

Get the provisionedMaxIops property: Optional.
Integer getQuotaInGb()

Gets the size in GB to limit the share's growth.
ShareRootSquash getRootSquash()

Gets the root squash to set for the share.
Boolean isPaidBurstingEnabled()

Get the enablePaidBursting property: Optional.
Boolean isSnapshotVirtualDirectoryAccessEnabled()

Get the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.
ShareCreateOptions setAccessTier(ShareAccessTier accessTier)

Sets the access tier for the share.
ShareCreateOptions setMetadata(Map<String,String> metadata)

Sets the metadata to associate with the share.
ShareCreateOptions setPaidBurstingEnabled(Boolean enablePaidBursting)

Set the enablePaidBursting property: Optional.
ShareCreateOptions setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)

Set the paidBurstingMaxBandwidthMibps property: Optional.
ShareCreateOptions setPaidBurstingMaxIops(Long paidBurstingMaxIops)

Set the paidBurstingMaxIops property: Optional.
ShareCreateOptions setProtocols(ShareProtocols protocols)

Sets the protocols to enable on the share.
ShareCreateOptions setProvisionedMaxBandwidthMibps(Long provisionedMaxBandwidthMibps)

Set the provisionedMaxBandwidthMibps property: Optional.
ShareCreateOptions setProvisionedMaxIops(Long provisionedMaxIops)

Set the provisionedMaxIops property: Optional.
ShareCreateOptions setQuotaInGb(Integer quotaInGb)

Sets the size in GB to limit the share's growth.
ShareCreateOptions setRootSquash(ShareRootSquash rootSquash)

Sets the root squash to set for the share.
ShareCreateOptions setSnapshotVirtualDirectoryAccessEnabled(Boolean snapshotVirtualDirectoryAccessEnabled)

Set the enableSnapshotVirtualDirectoryAccess property: Optional.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareCreateOptions

public ShareCreateOptions()

Creates a new instance of ShareCreateOptions.

Method Details

getAccessTier

public ShareAccessTier getAccessTier()

Gets the access tier for the share.

Returns:

getMetadata

public Map getMetadata()

Gets the metadata to associate with the share.

Returns:

Metadata to associate with the share

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()

Gets the protocols to enable on the share.

Returns:

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.

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.

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.

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.

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: 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 ShareCreateOptions setAccessTier(ShareAccessTier accessTier)

Sets the access tier for the share.

Parameters:

accessTier - ShareAccessTier.

Returns:

The updated options.

setMetadata

public ShareCreateOptions setMetadata(Map 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.

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.

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.

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.

setProtocols

public ShareCreateOptions setProtocols(ShareProtocols protocols)

Sets the protocols to enable on the share.

Parameters:

protocols - ShareProtocols

Returns:

The updated options.

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.

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.

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.

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.

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.

Applies to