Package com.azure.storage.blob.nio
Class AzureBlobFileAttributes
- java.lang.Object
-
- com.azure.storage.blob.nio.AzureBlobFileAttributes
-
- All Implemented Interfaces:
BasicFileAttributes
public final class AzureBlobFileAttributes extends Object implements BasicFileAttributes
Provides support for attributes associated with a file stored as a blob in Azure Storage.Some of the attributes inherited from
BasicFileAttributes
are not supported. See the docs on each method for more information.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessTier
accessTier()
Returns the tier of the blob.OffsetDateTime
accessTierChangeTime()
Returns the time when the access tier for the blob was last changed.ArchiveStatus
archiveStatus()
Returns the archive status of the blob.BlobHttpHeaders
blobHttpHeaders()
Returns theBlobHttpHeaders
of the blob.BlobType
blobType()
Returns the type of the blob.OffsetDateTime
copyCompletionTime()
Returns the completion time of the last copy operation.String
copyId()
Returns the identifier of the last copy operation.String
copyProgress()
Returns the number of bytes copied and total bytes in the source from the last copy operation (bytes copied/total bytes).String
copySource()
Returns the source blob URL from the last copy operation.CopyStatusType
copyStatus()
Returns the status of the last copy operation.String
copyStatusDescription()
Returns the description of the last copy failure, this is set when thegetCopyStatus
isfailed
oraborted
.FileTime
creationTime()
Returns the creation time.String
eTag()
Returns the eTag of the blob.Object
fileKey()
Returns the url of the resource.Boolean
isAccessTierInferred()
Returns the status of the tier being inferred for the blob.boolean
isDirectory()
Tells whether the file is a directory.boolean
isOther()
Tells whether the file is something other than a regular file, directory, or symbolic link.boolean
isRegularFile()
Tells whether the file is a regular file with opaque content.Boolean
isServerEncrypted()
Returns the status of the blob being encrypted on the server.boolean
isSymbolicLink()
Tells whether the file is a symbolic link.FileTime
lastAccessTime()
Returns the time of last modification.FileTime
lastModifiedTime()
Returns the time of last modification.Map<String,String>
metadata()
Returns the metadata associated with this blob.long
size()
Returns the size of the file (in bytes).
-
-
-
Method Detail
-
creationTime
public FileTime creationTime()
Returns the creation time. The creation time is the time that the file was created.- Specified by:
creationTime
in interfaceBasicFileAttributes
- Returns:
- The creation time.
-
lastModifiedTime
public FileTime lastModifiedTime()
Returns the time of last modification.- Specified by:
lastModifiedTime
in interfaceBasicFileAttributes
- Returns:
- the time of last modification.
-
eTag
public String eTag()
Returns the eTag of the blob.- Returns:
- the eTag of the blob
-
blobHttpHeaders
public BlobHttpHeaders blobHttpHeaders()
Returns theBlobHttpHeaders
of the blob.- Returns:
BlobHttpHeaders
-
blobType
public BlobType blobType()
Returns the type of the blob.- Returns:
- the type of the blob
-
copyId
public String copyId()
Returns the identifier of the last copy operation. If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the identifier of the last copy operation.
-
copyStatus
public CopyStatusType copyStatus()
Returns the status of the last copy operation. If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the status of the last copy operation.
-
copySource
public String copySource()
Returns the source blob URL from the last copy operation. If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the source blob URL from the last copy operation.
-
copyProgress
public String copyProgress()
Returns the number of bytes copied and total bytes in the source from the last copy operation (bytes copied/total bytes). If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the number of bytes copied and total bytes in the source from the last copy operation
-
copyCompletionTime
public OffsetDateTime copyCompletionTime()
Returns the completion time of the last copy operation. If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the completion time of the last copy operation.
-
copyStatusDescription
public String copyStatusDescription()
Returns the description of the last copy failure, this is set when thegetCopyStatus
isfailed
oraborted
. If this blob hasn't been the target of a copy operation or has been modified since this won't be set.- Returns:
- the description of the last copy failure.
-
isServerEncrypted
public Boolean isServerEncrypted()
Returns the status of the blob being encrypted on the server.- Returns:
- the status of the blob being encrypted on the server.
-
accessTier
public AccessTier accessTier()
Returns the tier of the blob. This is only set for Page blobs on a premium storage account or for Block blobs on blob storage or general purpose V2 account.- Returns:
- the tier of the blob.
-
isAccessTierInferred
public Boolean isAccessTierInferred()
Returns the status of the tier being inferred for the blob. This is only set for Page blobs on a premium storage account or for Block blobs on blob storage or general purpose V2 account.- Returns:
- the status of the tier being inferred for the blob.
-
archiveStatus
public ArchiveStatus archiveStatus()
Returns the archive status of the blob. This is only for blobs on a blob storage and general purpose v2 account.- Returns:
- the archive status of the blob.
-
accessTierChangeTime
public OffsetDateTime accessTierChangeTime()
Returns the time when the access tier for the blob was last changed.- Returns:
- the time when the access tier for the blob was last changed.
-
metadata
public Map<String,String> metadata()
Returns the metadata associated with this blob.- Returns:
- the metadata associated with this blob
-
lastAccessTime
public FileTime lastAccessTime()
Returns the time of last modification.Last access time is not supported by the blob service. In this case, it is typical for implementations to return the
lastModifiedTime()
.- Specified by:
lastAccessTime
in interfaceBasicFileAttributes
- Returns:
- the time of last modification.
-
isRegularFile
public boolean isRegularFile()
Tells whether the file is a regular file with opaque content.- Specified by:
isRegularFile
in interfaceBasicFileAttributes
- Returns:
- whether the file is a regular file.
-
isDirectory
public boolean isDirectory()
Tells whether the file is a directory.Will only return true if the directory is a concrete directory. See
AzureFileSystemProvider.createDirectory(Path, FileAttribute[])
for more information on virtual and concrete directories.- Specified by:
isDirectory
in interfaceBasicFileAttributes
- Returns:
- whether the file is a directory
-
isSymbolicLink
public boolean isSymbolicLink()
Tells whether the file is a symbolic link.- Specified by:
isSymbolicLink
in interfaceBasicFileAttributes
- Returns:
- false. Symbolic links are not supported.
-
isOther
public boolean isOther()
Tells whether the file is something other than a regular file, directory, or symbolic link.- Specified by:
isOther
in interfaceBasicFileAttributes
- Returns:
- false. No other object types are supported.
-
size
public long size()
Returns the size of the file (in bytes).- Specified by:
size
in interfaceBasicFileAttributes
- Returns:
- the size of the file
-
fileKey
public Object fileKey()
Returns the url of the resource.- Specified by:
fileKey
in interfaceBasicFileAttributes
- Returns:
- The file key, which is the url.
-
-