ShareSetPropertiesOptions Class

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

public class ShareSetPropertiesOptions

Extended options that may be passed when setting properties on a share.

Constructor Summary

Constructor	Description
ShareSetPropertiesOptions()

Method Summary

Modifier and Type	Method and Description
ShareAccessTier	getAccessTier()
Long	getPaidBurstingMaxBandwidthMibps() Get the paidBurstingMaxBandwidthMibps property: Optional.
Long	getPaidBurstingMaxIops() Get the paidBurstingMaxIops property: Optional.
Long	getProvisionedMaxBandwidthMibps() Get the provisionedMaxBandwidthMibps property: Optional.
Long	getProvisionedMaxIops() Get the provisionedMaxIops property: Optional.
Integer	getQuotaInGb()
ShareRequestConditions	getRequestConditions()
ShareRootSquash	getRootSquash()
Boolean	isPaidBurstingEnabled() Get the enablePaidBursting property: Optional.
Boolean	isSnapshotVirtualDirectoryAccessEnabled() Get the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.
ShareSetPropertiesOptions	setAccessTier(ShareAccessTier accessTier)
ShareSetPropertiesOptions	setPaidBurstingEnabled(Boolean enablePaidBursting) Set the enablePaidBursting property: Optional.
ShareSetPropertiesOptions	setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps) Set the paidBurstingMaxBandwidthMibps property: Optional.
ShareSetPropertiesOptions	setPaidBurstingMaxIops(Long paidBurstingMaxIops) Set the paidBurstingMaxIops property: Optional.
ShareSetPropertiesOptions	setProvisionedMaxBandwidthMibps(Long provisionedMaxBandwidthMibps) Set the provisionedMaxBandwidthMibps property: Optional.
ShareSetPropertiesOptions	setProvisionedMaxIops(Long provisionedMaxIops) Set the provisionedMaxIops property: Optional.
ShareSetPropertiesOptions	setQuotaInGb(Integer quotaInGb)
ShareSetPropertiesOptions	setRequestConditions(ShareRequestConditions requestConditions)
ShareSetPropertiesOptions	setRootSquash(ShareRootSquash rootSquash)
ShareSetPropertiesOptions	setSnapshotVirtualDirectoryAccessEnabled(Boolean snapshotVirtualDirectoryAccessEnabled) Set the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareSetPropertiesOptions

public ShareSetPropertiesOptions()

Method Details

getAccessTier

public ShareAccessTier getAccessTier()

Returns:

ShareAccessTier

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.

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

Returns:

Size in GB to limit the share's growth.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Returns:

ShareRequestConditions.

getRootSquash

public ShareRootSquash getRootSquash()

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

Parameters:

accessTier - ShareAccessTier.

Returns:

The updated options.

setPaidBurstingEnabled

public ShareSetPropertiesOptions 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.

setPaidBurstingMaxBandwidthMibps

public ShareSetPropertiesOptions 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.

setPaidBurstingMaxIops

public ShareSetPropertiesOptions 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.

setProvisionedMaxBandwidthMibps

public ShareSetPropertiesOptions 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 ShareSetPropertiesOptions object itself.

setProvisionedMaxIops

public ShareSetPropertiesOptions 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 ShareSetPropertiesOptions object itself.

setQuotaInGb

public ShareSetPropertiesOptions setQuotaInGb(Integer quotaInGb)

Parameters:

quotaInGb - Size in GB to limit the share's growth.

Returns:

The updated options.

setRequestConditions

public ShareSetPropertiesOptions setRequestConditions(ShareRequestConditions requestConditions)

Parameters:

requestConditions - ShareRequestConditions.

Returns:

The updated options.

setRootSquash

public ShareSetPropertiesOptions setRootSquash(ShareRootSquash rootSquash)

Parameters:

rootSquash - The root squash to set for the share. Only valid for NFS.

Returns:

The updated options.

setSnapshotVirtualDirectoryAccessEnabled

public ShareSetPropertiesOptions setSnapshotVirtualDirectoryAccessEnabled(Boolean snapshotVirtualDirectoryAccessEnabled)

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

Parameters:

snapshotVirtualDirectoryAccessEnabled - the enableSnapshotVirtualDirectoryAccess value to set.

Returns:

the ShareSetPropertiesOptions object itself.