Share via

FileShareItemInner Class

  • Reference
Package:
com.azure.resourcemanager.storage.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-storage:2.44.0

public final class FileShareItemInner
extends AzureEntityResource

The file share properties be listed out.

Constructor Summary

Constructor Description
FileShareItemInner()

Creates an instance of FileShareItemInner class.

Method Summary

Modifier and Type Method and Description
ShareAccessTier accessTier()

Get the accessTier property: Access tier for specific share.
OffsetDateTime accessTierChangeTime()

Get the accessTierChangeTime property: Indicates the last modification time for share access tier.
String accessTierStatus()

Get the accessTierStatus property: Indicates if there is a pending transition for access tier.
Boolean deleted()

Get the deleted property: Indicates whether the share was deleted.
OffsetDateTime deletedTime()

Get the deletedTime property: The deleted time if the share was deleted.
EnabledProtocols enabledProtocols()

Get the enabledProtocols property: The authentication protocol that is used for the file share.
String etag()

Get the etag property: Resource Etag.
static FileShareItemInner fromJson(JsonReader jsonReader)

Reads an instance of FileShareItemInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
OffsetDateTime lastModifiedTime()

Get the lastModifiedTime property: Returns the date and time the share was last modified.
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.
LeaseState leaseState()

Get the leaseState property: Lease state of the share.
LeaseStatus leaseStatus()

Get the leaseStatus property: The lease status of the share.
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.
Integer remainingRetentionDays()

Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.
RootSquashType rootSquash()

Get the rootSquash property: The property is for NFS share only.
Integer shareQuota()

Get the shareQuota property: The maximum size of the share, in gigabytes.
Long shareUsageBytes()

Get the shareUsageBytes property: The approximate size of the data stored on the share.
List<SignedIdentifier> signedIdentifiers()

Get the signedIdentifiers property: List of stored access policies specified on the share.
OffsetDateTime snapshotTime()

Get the snapshotTime property: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
JsonWriter toJson(JsonWriter jsonWriter)
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.
FileShareItemInner withAccessTier(ShareAccessTier accessTier)

Set the accessTier property: Access tier for specific share.
FileShareItemInner withEnabledProtocols(EnabledProtocols enabledProtocols)

Set the enabledProtocols property: The authentication protocol that is used for the file share.
FileShareItemInner withMetadata(Map<String,String> metadata)

Set the metadata property: A name-value pair to associate with the share as metadata.
FileShareItemInner withRootSquash(RootSquashType rootSquash)

Set the rootSquash property: The property is for NFS share only.
FileShareItemInner withShareQuota(Integer shareQuota)

Set the shareQuota property: The maximum size of the share, in gigabytes.
FileShareItemInner withSignedIdentifiers(List<SignedIdentifier> signedIdentifiers)

Set the signedIdentifiers property: List of stored access policies specified on the share.

Methods inherited from AzureEntityResource

etag fromJson id name toJson type validate

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FileShareItemInner

public FileShareItemInner()

Creates an instance of FileShareItemInner class.

Method Details

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:

the accessTier value.

accessTierChangeTime

public OffsetDateTime accessTierChangeTime()

Get the accessTierChangeTime property: Indicates the last modification time for share access tier.

Returns:

the accessTierChangeTime value.

accessTierStatus

public String accessTierStatus()

Get the accessTierStatus property: Indicates if there is a pending transition for access tier.

Returns:

the accessTierStatus value.

deleted

public Boolean deleted()

Get the deleted property: Indicates whether the share was deleted.

Returns:

the deleted value.

deletedTime

public OffsetDateTime deletedTime()

Get the deletedTime property: The deleted time if the share was deleted.

Returns:

the deletedTime value.

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:

the enabledProtocols value.

etag

public String etag()

Get the etag property: Resource Etag.

Overrides:

FileShareItemInner.etag()

Returns:

the etag value.

fromJson

public static FileShareItemInner fromJson(JsonReader jsonReader)

Reads an instance of FileShareItemInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FileShareItemInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

FileShareItemInner.id()

Returns:

the id value.

lastModifiedTime

public OffsetDateTime lastModifiedTime()

Get the lastModifiedTime property: Returns the date and time the share was last modified.

Returns:

the lastModifiedTime value.

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:

the leaseDuration value.

leaseState

public LeaseState leaseState()

Get the leaseState property: Lease state of the share.

Returns:

the leaseState value.

leaseStatus

public LeaseStatus leaseStatus()

Get the leaseStatus property: The lease status of the share.

Returns:

the leaseStatus value.

metadata

public Map metadata()

Get the metadata property: A name-value pair to associate with the share as metadata.

Returns:

the metadata value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

FileShareItemInner.name()

Returns:

the name value.

remainingRetentionDays

public Integer remainingRetentionDays()

Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.

Returns:

the remainingRetentionDays value.

rootSquash

public RootSquashType rootSquash()

Get the rootSquash property: The property is for NFS share only. The default is NoRootSquash.

Returns:

the rootSquash value.

shareQuota

public Integer shareQuota()

Get the shareQuota property: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.

Returns:

the shareQuota value.

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:

the shareUsageBytes value.

signedIdentifiers

public List signedIdentifiers()

Get the signedIdentifiers property: List of stored access policies specified on the share.

Returns:

the signedIdentifiers value.

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:

the snapshotTime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FileShareItemInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

FileShareItemInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

FileShareItemInner.validate()

version

public String version()

Get the version property: The version of the share.

Returns:

the version value.

withAccessTier

public FileShareItemInner 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:

accessTier - the accessTier value to set.

Returns:

the FileShareItemInner object itself.

withEnabledProtocols

public FileShareItemInner 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:

enabledProtocols - the enabledProtocols value to set.

Returns:

the FileShareItemInner object itself.

withMetadata

public FileShareItemInner withMetadata(Map metadata)

Set the metadata property: A name-value pair to associate with the share as metadata.

Parameters:

metadata - the metadata value to set.

Returns:

the FileShareItemInner object itself.

withRootSquash

public FileShareItemInner withRootSquash(RootSquashType rootSquash)

Set the rootSquash property: The property is for NFS share only. The default is NoRootSquash.

Parameters:

rootSquash - the rootSquash value to set.

Returns:

the FileShareItemInner object itself.

withShareQuota

public FileShareItemInner withShareQuota(Integer shareQuota)

Set the shareQuota property: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.

Parameters:

shareQuota - the shareQuota value to set.

Returns:

the FileShareItemInner object itself.

withSignedIdentifiers

public FileShareItemInner withSignedIdentifiers(List signedIdentifiers)

Set the signedIdentifiers property: List of stored access policies specified on the share.

Parameters:

signedIdentifiers - the signedIdentifiers value to set.

Returns:

the FileShareItemInner object itself.

Applies to