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

    If the target file is a virtual directory, most attributes will be set to null.

    • Method Detail

      • creationTime

        public FileTime creationTime()
        Returns the creation time. The creation time is the time that the file was created. Returns null if this is a virtual directory.
        Specified by:
        creationTime in interface BasicFileAttributes
        Returns:
        The creation time or null if this is a virtual directory
      • lastModifiedTime

        public FileTime lastModifiedTime()
        Returns the time of last modification. Returns null if this is a virtual directory
        Specified by:
        lastModifiedTime in interface BasicFileAttributes
        Returns:
        the time of last modification or null if this is a virtual directory
      • eTag

        public String eTag()
        Returns the eTag of the blob or null if this is a virtual directory
        Returns:
        the eTag of the blob or null if this is a virtual directory
      • blobType

        public BlobType blobType()
        Returns the type of the blob or null if this is a virtual directory
        Returns:
        the type of the blob or null if this is a virtual directory
      • 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 null if this is a virtual directory
        Returns:
        the identifier of the last copy operation or null if this is a virtual directory
      • 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 null if this is a virtual directory
        Returns:
        the status of the last copy operation or null if this is a virtual directory
      • 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 null if this is a virtual directory
        Returns:
        the source blob URL from the last copy operation or null if this is a virtual directory
      • 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 null if this is a virtual directory
        Returns:
        the number of bytes copied and total bytes in the source from the last copy operation null if this is a virtual directory
      • 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 null if this is a virtual directory.
        Returns:
        the completion time of the last copy operation or null if this is a virtual directory
      • copyStatusDescription

        public String copyStatusDescription()
        Returns the description of the last copy failure, this is set when the getCopyStatus is failed or aborted. If this blob hasn't been the target of a copy operation or has been modified since this won't be set. Returns null if this is a virtual directory.
        Returns:
        the description of the last copy failure or null if this is a virtual directory
      • isServerEncrypted

        public Boolean isServerEncrypted()
        Returns the status of the blob being encrypted on the server or null if this is a virtual directory.
        Returns:
        the status of the blob being encrypted on the server or null if this is a virtual directory
      • 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 null if this is a virtual directory.
        Returns:
        the tier of the blob or null if this is a virtual directory
      • 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 null if this is a virtual directory.
        Returns:
        the status of the tier being inferred for the blob or null if this is a virtual directory
      • 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 null if this is a virtual directory.
        Returns:
        the archive status of the blob or null if this is a virtual directory
      • accessTierChangeTime

        public OffsetDateTime accessTierChangeTime()
        Returns the time when the access tier for the blob was last changed or null if this is a virtual directory.
        Returns:
        the time when the access tier for the blob was last changed or null if this is a virtual directory
      • metadata

        public Map<String,​String> metadata()
        Returns the metadata associated with this blob or null if this is a virtual directory.
        Returns:
        the metadata associated with this blob or null if this is a virtual directory
      • lastAccessTime

        public FileTime lastAccessTime()
        Returns the time of last modification or null if this is a virtual directory.

        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 interface BasicFileAttributes
        Returns:
        the time of last modification or null if this is a virtual directory
      • isRegularFile

        public boolean isRegularFile()
        Tells whether the file is a regular file with opaque content.
        Specified by:
        isRegularFile in interface BasicFileAttributes
        Returns:
        whether the file is a regular file.
      • isSymbolicLink

        public boolean isSymbolicLink()
        Tells whether the file is a symbolic link.
        Specified by:
        isSymbolicLink in interface BasicFileAttributes
        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 interface BasicFileAttributes
        Returns:
        false. No other object types are supported.
      • size

        public long size()
        Returns the size of the file (in bytes).
        Specified by:
        size in interface BasicFileAttributes
        Returns:
        the size of the file
      • fileKey

        public Object fileKey()
        Returns the url of the resource.
        Specified by:
        fileKey in interface BasicFileAttributes
        Returns:
        The file key, which is the url.