FileShareInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. resourcemanager. storage. models. AzureEntityResource - com.
azure. resourcemanager. storage. fluent. models. FileShareInner
- com.
- com.
- com.
public final class FileShareInner
extends AzureEntityResource
Properties of the file share, including Id, resource name, resource type, Etag.
| Constructor | Description |
|---|---|
|
File |
Creates an instance of File |
| Modifier and Type | Method and Description |
|---|---|
|
Share |
access Get the access |
|
Offset |
access Get the access |
| String |
access Get the access |
| Boolean |
deleted()
Get the deleted property: Indicates whether the share was deleted. |
|
Offset |
deleted Get the deleted |
|
Enabled |
enabled Get the enabled |
| String |
etag()
Get the etag property: Resource Etag. |
|
File |
file Get the file |
|
static
File |
from Reads an instance of File |
| String |
id()
Get the id property: Fully qualified resource Id for the resource. |
| Integer |
included Get the included |
|
Offset |
last Get the last |
|
Lease |
lease Get the lease |
|
Lease |
lease Get the lease |
|
Lease |
lease Get the lease |
| Long |
max Get the max |
| Map<String,String> |
metadata()
Get the metadata property: A name-value pair to associate with the share as metadata. |
| String |
name()
Get the name property: The name of the resource. |
|
Offset |
next Get the next |
|
Offset |
next Get the next |
|
Offset |
next Get the next |
| Integer |
provisioned Get the provisioned |
| Integer |
provisioned Get the provisioned |
| Integer |
remaining Get the remaining |
|
Root |
root Get the root |
| Integer |
share Get the share |
| Long |
share Get the share |
|
List<Signed |
signed Get the signed |
|
Offset |
snapshot Get the snapshot |
|
Json |
to |
| String |
type()
Get the type property: The type of the resource. |
| void |
validate()
Validates the instance. |
| String |
version()
Get the version property: The version of the share. |
|
File |
with Set the access |
|
File |
with Set the enabled |
|
File |
with Set the file |
|
File |
with Set the metadata property: A name-value pair to associate with the share as metadata. |
|
File |
with Set the provisioned |
|
File |
with Set the provisioned |
|
File |
with Set the root |
|
File |
with Set the share |
|
File |
with Set the signed |
Methods inherited from AzureEntityResource
Methods inherited from java.lang.Object
FileShareInner
public FileShareInner()
Creates an instance of FileShareInner class.
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:
accessTierChangeTime
public OffsetDateTime accessTierChangeTime()
Get the accessTierChangeTime property: Indicates the last modification time for share access tier.
Returns:
accessTierStatus
public String accessTierStatus()
Get the accessTierStatus property: Indicates if there is a pending transition for access tier.
Returns:
deleted
public Boolean deleted()
Get the deleted property: Indicates whether the share was deleted.
Returns:
deletedTime
public OffsetDateTime deletedTime()
Get the deletedTime property: The deleted time if the share was deleted.
Returns:
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:
etag
public String etag()
Get the etag property: Resource Etag.
Overrides:
FileShareInner.etag()Returns:
fileSharePaidBursting
public FileSharePropertiesFileSharePaidBursting fileSharePaidBursting()
Get the fileSharePaidBursting property: File Share Paid Bursting properties.
Returns:
fromJson
public static FileShareInner fromJson(JsonReader jsonReader)
Reads an instance of FileShareInner from the JsonReader.
Parameters:
Returns:
Throws:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
FileShareInner.id()Returns:
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:
lastModifiedTime
public OffsetDateTime lastModifiedTime()
Get the lastModifiedTime property: Returns the date and time the share was last modified.
Returns:
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:
leaseState
public LeaseState leaseState()
Get the leaseState property: Lease state of the share.
Returns:
leaseStatus
public LeaseStatus leaseStatus()
Get the leaseStatus property: The lease status of the share.
Returns:
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:
metadata
public Map
Get the metadata property: A name-value pair to associate with the share as metadata.
Returns:
name
public String name()
Get the name property: The name of the resource.
Overrides:
FileShareInner.name()Returns:
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:
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:
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:
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:
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:
remainingRetentionDays
public Integer remainingRetentionDays()
Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.
Returns:
rootSquash
public RootSquashType rootSquash()
Get the rootSquash property: The property is for NFS share only. The default is NoRootSquash.
Returns:
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:
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:
signedIdentifiers
public List
Get the signedIdentifiers property: List of stored access policies specified on the share.
Returns:
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:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
FileShareInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
FileShareInner.type()Returns:
validate
public void validate()
Validates the instance.
Overrides:
FileShareInner.validate()version
public String version()
Get the version property: The version of the share.
Returns:
withAccessTier
public FileShareInner 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:
Returns:
withEnabledProtocols
public FileShareInner 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:
Returns:
withFileSharePaidBursting
public FileShareInner withFileSharePaidBursting(FileSharePropertiesFileSharePaidBursting fileSharePaidBursting)
Set the fileSharePaidBursting property: File Share Paid Bursting properties.
Parameters:
Returns:
withMetadata
public FileShareInner withMetadata(Map
Set the metadata property: A name-value pair to associate with the share as metadata.
Parameters:
Returns:
withProvisionedBandwidthMibps
public FileShareInner 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:
Returns:
withProvisionedIops
public FileShareInner 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:
Returns:
withRootSquash
public FileShareInner withRootSquash(RootSquashType rootSquash)
Set the rootSquash property: The property is for NFS share only. The default is NoRootSquash.
Parameters:
Returns:
withShareQuota
public FileShareInner 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:
Returns:
withSignedIdentifiers
public FileShareInner withSignedIdentifiers(List
Set the signedIdentifiers property: List of stored access policies specified on the share.
Parameters:
Returns:
