ShareProperties Class

Package:

com.azure.storage.file.share.models

Maven Artifact:

com.azure:azure-storage-file-share:12.21.4

• java.lang.Object
• • com.azure.storage.file.share.models.ShareProperties

public final class ShareProperties

Properties of a share.

Constructor Summary

Constructor	Description
ShareProperties()

Method Summary

Modifier and Type	Method and Description
String	getAccessTier() Get the accessTier property: The accessTier property.
OffsetDateTime	getAccessTierChangeTime() Get the accessTierChangeTime property: The accessTierChangeTime property.
String	getAccessTierTransitionState() Get the accessTierTransitionState property: The accessTierTransitionState property.
OffsetDateTime	getDeletedTime() Get the deletedTime property: The deletedTime property.
String	getETag() Get the eTag property: The eTag property.
OffsetDateTime	getLastModified() Get the lastModified property: The lastModified property.
LeaseDurationType	getLeaseDuration() Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.
LeaseStateType	getLeaseState() Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
LeaseStatusType	getLeaseStatus() Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.
Map<String,String>	getMetadata() Get the metadata property: The metadata property.
OffsetDateTime	getNextAllowedQuotaDowngradeTime() Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
ShareProtocols	getProtocols() Get the enabledProtocols property: The enabledProtocols property.
Integer	getProvisionedBandwidthMiBps() Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
Integer	getProvisionedEgressMBps() Deprecated Please use getProvisionedBandwidthMiBps() Get the provisionedEgressMBps property: The provisionedEgressMBps property.
Integer	getProvisionedIngressMBps() Deprecated Please use getProvisionedBandwidthMiBps() Get the provisionedIngressMBps property: The provisionedIngressMBps property.
Integer	getProvisionedIops() Get the provisionedIops property: The provisionedIops property.
int	getQuota() Get the quota property: The quota property.
Integer	getRemainingRetentionDays() Get the remainingRetentionDays property: The remainingRetentionDays property.
ShareRootSquash	getRootSquash() Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
ShareProperties	setAccessTier(String accessTier) Set the accessTier property: The accessTier property.
ShareProperties	setAccessTierChangeTime(OffsetDateTime accessTierChangeTime) Set the accessTierChangeTime property: The accessTierChangeTime property.
ShareProperties	setAccessTierTransitionState(String accessTierTransitionState) Set the accessTierTransitionState property: The accessTierTransitionState property.
ShareProperties	setDeletedTime(OffsetDateTime deletedTime) Set the deletedTime property: The deletedTime property.
ShareProperties	setETag(String eTag) Set the eTag property: The eTag property.
ShareProperties	setLastModified(OffsetDateTime lastModified) Set the lastModified property: The lastModified property.
ShareProperties	setLeaseDuration(LeaseDurationType leaseDuration) Set the leaseDuration property: Possible values include: 'infinite', 'fixed'.
ShareProperties	setLeaseState(LeaseStateType leaseState) Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
ShareProperties	setLeaseStatus(LeaseStatusType leaseStatus) Set the leaseStatus property: Possible values include: 'locked', 'unlocked'.
ShareProperties	setMetadata(Map<String,String> metadata) Set the metadata property: The metadata property.
ShareProperties	setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime) Set the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.
ShareProperties	setProtocols(ShareProtocols protocols) Set the enabledProtocols property: The enabledProtocols property.
ShareProperties	setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) Set the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.
ShareProperties	setProvisionedEgressMBps(Integer provisionedEgressMBps) Deprecated Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()} Set the provisionedEgressMBps property: The provisionedEgressMBps property.
ShareProperties	setProvisionedIngressMBps(Integer provisionedIngressMBps) Deprecated Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()} Set the provisionedIngressMBps property: The provisionedIngressMBps property.
ShareProperties	setProvisionedIops(Integer provisionedIops) Set the provisionedIops property: The provisionedIops property.
ShareProperties	setQuota(int quota) Set the quota property: The quota property.
ShareProperties	setRemainingRetentionDays(Integer remainingRetentionDays) Set the remainingRetentionDays property: The remainingRetentionDays property.
ShareProperties	setRootSquash(ShareRootSquash rootSquash) Set the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareProperties

public ShareProperties()

Method Details

getAccessTier

public String getAccessTier()

Get the accessTier property: The accessTier property.

Returns:

the accessTier value.

getAccessTierChangeTime

public OffsetDateTime getAccessTierChangeTime()

Get the accessTierChangeTime property: The accessTierChangeTime property.

Returns:

the accessTierChangeTime value.

getAccessTierTransitionState

public String getAccessTierTransitionState()

Get the accessTierTransitionState property: The accessTierTransitionState property.

Returns:

the accessTierTransitionState value.

getDeletedTime

public OffsetDateTime getDeletedTime()

Get the deletedTime property: The deletedTime property.

Returns:

the deletedTime value.

getETag

public String getETag()

Get the eTag property: The eTag property.

Returns:

the eTag value.

getLastModified

public OffsetDateTime getLastModified()

Get the lastModified property: The lastModified property.

Returns:

the lastModified value.

getLeaseDuration

public LeaseDurationType getLeaseDuration()

Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.

Returns:

the leaseDuration value.

getLeaseState

public LeaseStateType getLeaseState()

Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.

Returns:

the leaseState value.

getLeaseStatus

public LeaseStatusType getLeaseStatus()

Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.

Returns:

the leaseStatus value.

getMetadata

public Map getMetadata()

Get the metadata property: The metadata property.

Returns:

the metadata value.

getNextAllowedQuotaDowngradeTime

public OffsetDateTime getNextAllowedQuotaDowngradeTime()

Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property.

Returns:

the nextAllowedQuotaDowngradeTime value.

getProtocols

public ShareProtocols getProtocols()

Get the enabledProtocols property: The enabledProtocols property.

Returns:

the enabledProtocols value.

getProvisionedBandwidthMiBps

public Integer getProvisionedBandwidthMiBps()

Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property.

Returns:

the provisionedBandwidthMiBps value.

getProvisionedEgressMBps

@Deprecated
public Integer getProvisionedEgressMBps()

Deprecated

Please use getProvisionedBandwidthMiBps()

Get the provisionedEgressMBps property: The provisionedEgressMBps property.

Returns:

the provisionedEgressMBps value.

getProvisionedIngressMBps

@Deprecated
public Integer getProvisionedIngressMBps()

Deprecated

Please use getProvisionedBandwidthMiBps()

Get the provisionedIngressMBps property: The provisionedIngressMBps property.

Returns:

the provisionedIngressMBps value.

getProvisionedIops

public Integer getProvisionedIops()

Get the provisionedIops property: The provisionedIops property.

Returns:

the provisionedIops value.

getQuota

public int getQuota()

Get the quota property: The quota property.

Returns:

the quota value.

getRemainingRetentionDays

public Integer getRemainingRetentionDays()

Get the remainingRetentionDays property: The remainingRetentionDays property.

Returns:

the remainingRetentionDays value.

getRootSquash

public ShareRootSquash getRootSquash()

Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Returns:

the rootSquash 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.

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.

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.

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.

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.

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.

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.

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.

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.

setMetadata

public ShareProperties setMetadata(Map metadata)

Set the metadata property: The metadata property.

Parameters:

metadata - the metadata value to set.

Returns:

the ShareProperties object itself.

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.

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.

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.

setProvisionedEgressMBps

@Deprecated
public ShareProperties setProvisionedEgressMBps(Integer provisionedEgressMBps)

Deprecated

Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()}

Set the provisionedEgressMBps property: The provisionedEgressMBps property.

Parameters:

provisionedEgressMBps - the provisionedEgressMBps value to set.

Returns:

the ShareProperties object itself.

setProvisionedIngressMBps

@Deprecated
public ShareProperties setProvisionedIngressMBps(Integer provisionedIngressMBps)

Deprecated

Please use setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps) ()}

Set the provisionedIngressMBps property: The provisionedIngressMBps property.

Parameters:

provisionedIngressMBps - the provisionedIngressMBps value to set.

Returns:

the ShareProperties object itself.

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.

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.

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.

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.