PathProperties Class

Package:

com.azure.storage.file.datalake.models

Maven Artifact:

com.azure:azure-storage-file-datalake:12.23.0

• java.lang.Object
• • com.azure.storage.file.datalake.models.PathProperties

public class PathProperties

This class contains the response information returned from the service when getting path properties.

Constructor Summary

Constructor	Description
PathProperties(OffsetDateTime creationTime, OffsetDateTime lastModified, String eTag, long fileSize, String contentType, byte[] contentMd5, String contentEncoding, String contentDisposition, String contentLanguage, String cacheControl, LeaseStatusType leaseStatus, LeaseStateType leaseState, LeaseDurationType leaseDuration, String copyId, CopyStatusType copyStatus, String copySource, String copyProgress, OffsetDateTime copyCompletionTime, String copyStatusDescription, Boolean isServerEncrypted, Boolean isIncrementalCopy, AccessTier accessTier, ArchiveStatus archiveStatus, String encryptionKeySha256, OffsetDateTime accessTierChangeTime, Map<String,String> metadata)	Constructs a PathProperties.
PathProperties(OffsetDateTime creationTime, OffsetDateTime lastModified, String eTag, long fileSize, String contentType, byte[] contentMd5, String contentEncoding, String contentDisposition, String contentLanguage, String cacheControl, LeaseStatusType leaseStatus, LeaseStateType leaseState, LeaseDurationType leaseDuration, String copyId, CopyStatusType copyStatus, String copySource, String copyProgress, OffsetDateTime copyCompletionTime, String copyStatusDescription, Boolean isServerEncrypted, Boolean isIncrementalCopy, AccessTier accessTier, ArchiveStatus archiveStatus, String encryptionKeySha256, OffsetDateTime accessTierChangeTime, Map<String,String> metadata, OffsetDateTime expiresOn)	Constructs a PathProperties.

Method Summary

Modifier and Type	Method and Description
List<PathAccessControlEntry>	getAccessControlList() Optional.
AccessTier	getAccessTier() Gets the tier of the path.
OffsetDateTime	getAccessTierChangeTime() Gets the time when the access tier for the path was last changed.
ArchiveStatus	getArchiveStatus() Gets the archive status of the path.
String	getCacheControl() Gets the cache control of the path.
String	getContentDisposition() Gets the content disposition of the path.
String	getContentEncoding() Gets the content encoding of the path.
String	getContentLanguage() Gets the content language of the path.
byte[]	getContentMd5() Gets the MD5 of the path's content.
String	getContentType() Gets the content type of the path.
OffsetDateTime	getCopyCompletionTime() Gets the completion time of the last copy operation.
String	getCopyId() Gets the identifier of the last copy operation.
String	getCopyProgress() Gets the number of bytes copied and total bytes in the source from the last copy operation.
String	getCopySource() Gets the source path URL from the last copy operation.
CopyStatusType	getCopyStatus() Gets the status of the last copy operation.
String	getCopyStatusDescription() Gets the description of the last copy failure.
OffsetDateTime	getCreationTime() Gets the time when the path was created.
String	getEncryptionContext() Gets the encryption context for this path.
String	getEncryptionKeySha256() Gets the SHA256 of the encryption key used to encrypt the path.
String	getEncryptionScope() Gets the path's encryption scope.
String	getETag() Gets the eTag of the path.
OffsetDateTime	getExpiresOn() Gets the time when the path is going to expire.
long	getFileSize() Gets the size of the path in bytes.
String	getGroup() Get the group property of the path: The owner property.
OffsetDateTime	getLastModified() Gets the time when the path was last modified.
LeaseDurationType	getLeaseDuration() Gets the lease duration if the path is leased.
LeaseStateType	getLeaseState() Gets the lease state of the path.
LeaseStatusType	getLeaseStatus() Gets the lease status of the path.
Map<String,String>	getMetadata() Gets the metadata associated to this path.
String	getOwner() Get the owner property of the path: The owner property.
String	getPermissions() Get the permissions property of the path: The permissions property.
Boolean	isDirectory() Gets whether this path represents a directory.
Boolean	isIncrementalCopy() Gets the status of the path being an incremental copy file.
Boolean	isServerEncrypted() Gets the status of the path being encrypted on the server.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PathProperties

public PathProperties(OffsetDateTime creationTime, OffsetDateTime lastModified, String eTag, long fileSize, String contentType, byte[] contentMd5, String contentEncoding, String contentDisposition, String contentLanguage, String cacheControl, LeaseStatusType leaseStatus, LeaseStateType leaseState, LeaseDurationType leaseDuration, String copyId, CopyStatusType copyStatus, String copySource, String copyProgress, OffsetDateTime copyCompletionTime, String copyStatusDescription, Boolean isServerEncrypted, Boolean isIncrementalCopy, AccessTier accessTier, ArchiveStatus archiveStatus, String encryptionKeySha256, OffsetDateTime accessTierChangeTime, Map metadata)

Constructs a PathProperties.

Parameters:

creationTime - Creation time of the file.

lastModified - Datetime when the file was last modified.

eTag - ETag of the file.

fileSize - Size of the file.

contentType - Content type specified for the file.

contentMd5 - Content MD5 specified for the file.

contentEncoding - Content encoding specified for the file.

contentDisposition - Content disposition specified for the file.

contentLanguage - Content language specified for the file.

cacheControl - Cache control specified for the file.

leaseStatus - Status of the lease on the file.

leaseState - State of the lease on the file.

leaseDuration - Type of lease on the file.

copyId - Identifier of the last copy operation performed on the file.

copyStatus - Status of the last copy operation performed on the file.

copySource - Source of the last copy operation performed on the file.

copyProgress - Progress of the last copy operation performed on the file.

copyCompletionTime - Datetime when the last copy operation on the file completed.

copyStatusDescription - Description of the last copy operation on the file.

isServerEncrypted - Flag indicating if the file's content is encrypted on the server.

isIncrementalCopy - Flag indicating if the file was incrementally copied.

accessTier - Access tier of the file.

archiveStatus - Archive status of the file.

encryptionKeySha256 - SHA256 of the customer provided encryption key used to encrypt the file on the server.

accessTierChangeTime - Datetime when the access tier of the file last changed.

metadata - Metadata associated with the file. pass null.

PathProperties

public PathProperties(OffsetDateTime creationTime, OffsetDateTime lastModified, String eTag, long fileSize, String contentType, byte[] contentMd5, String contentEncoding, String contentDisposition, String contentLanguage, String cacheControl, LeaseStatusType leaseStatus, LeaseStateType leaseState, LeaseDurationType leaseDuration, String copyId, CopyStatusType copyStatus, String copySource, String copyProgress, OffsetDateTime copyCompletionTime, String copyStatusDescription, Boolean isServerEncrypted, Boolean isIncrementalCopy, AccessTier accessTier, ArchiveStatus archiveStatus, String encryptionKeySha256, OffsetDateTime accessTierChangeTime, Map metadata, OffsetDateTime expiresOn)

Constructs a PathProperties.

Parameters:

creationTime - Creation time of the file.

lastModified - Datetime when the file was last modified.

eTag - ETag of the file.

fileSize - Size of the file.

contentType - Content type specified for the file.

contentMd5 - Content MD5 specified for the file.

contentEncoding - Content encoding specified for the file.

contentDisposition - Content disposition specified for the file.

contentLanguage - Content language specified for the file.

cacheControl - Cache control specified for the file.

leaseStatus - Status of the lease on the file.

leaseState - State of the lease on the file.

leaseDuration - Type of lease on the file.

copyId - Identifier of the last copy operation performed on the file.

copyStatus - Status of the last copy operation performed on the file.

copySource - Source of the last copy operation performed on the file.

copyProgress - Progress of the last copy operation performed on the file.

copyCompletionTime - Datetime when the last copy operation on the file completed.

copyStatusDescription - Description of the last copy operation on the file.

isServerEncrypted - Flag indicating if the file's content is encrypted on the server.

isIncrementalCopy - Flag indicating if the file was incrementally copied.

accessTier - Access tier of the file.

archiveStatus - Archive status of the file.

encryptionKeySha256 - SHA256 of the customer provided encryption key used to encrypt the file on the server.

accessTierChangeTime - Datetime when the access tier of the file last changed.

metadata - Metadata associated with the file. pass null.

expiresOn - the time when the path is going to expire.

Method Details

getAccessControlList

public List getAccessControlList()

Optional. The POSIX access control list for the file or directory.

Returns:

the access control list.

getAccessTier

public AccessTier getAccessTier()

Gets the tier of the path.

Returns:

the tier of the path.

getAccessTierChangeTime

public OffsetDateTime getAccessTierChangeTime()

Gets the time when the access tier for the path was last changed.

Returns:

the time when the access tier for the path was last changed

getArchiveStatus

public ArchiveStatus getArchiveStatus()

Gets the archive status of the path.

Returns:

the archive status of the path.

getCacheControl

public String getCacheControl()

Gets the cache control of the path.

Returns:

the cache control of the path

getContentDisposition

public String getContentDisposition()

Gets the content disposition of the path.

Returns:

the content disposition of the path

getContentEncoding

public String getContentEncoding()

Gets the content encoding of the path.

Returns:

the content encoding of the path

getContentLanguage

public String getContentLanguage()

Gets the content language of the path.

Returns:

the content language of the path

getContentMd5

public byte[] getContentMd5()

Gets the MD5 of the path's content.

Returns:

the MD5 of the path's content

getContentType

public String getContentType()

Gets the content type of the path.

Returns:

the content type of the path

getCopyCompletionTime

public OffsetDateTime getCopyCompletionTime()

Gets the completion time of the last copy operation.

Returns:

the completion time of the last copy operation. If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCopyId

public String getCopyId()

Gets the identifier of the last copy operation.

Returns:

the identifier of the last copy operation. If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCopyProgress

public String getCopyProgress()

Gets the number of bytes copied and total bytes in the source from the last copy operation.

Returns:

the number of bytes copied and total bytes in the source from the last copy operation (bytes copied/total bytes). If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCopySource

public String getCopySource()

Gets the source path URL from the last copy operation.

Returns:

the source path URL from the last copy operation. If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCopyStatus

public CopyStatusType getCopyStatus()

Gets the status of the last copy operation.

Returns:

the status of the last copy operation. If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCopyStatusDescription

public String getCopyStatusDescription()

Gets the description of the last copy failure.

Returns:

the description of the last copy failure, this is set when the getCopyStatus() is FAILED or ABORTED. If this path hasn't been the target of a copy operation or has been modified since this won't be set.

getCreationTime

public OffsetDateTime getCreationTime()

Gets the time when the path was created.

Returns:

the time when the path was created

getEncryptionContext

public String getEncryptionContext()

Gets the encryption context for this path. Only applicable for files.

Returns:

the encryption context for this path. Only applicable for files.

getEncryptionKeySha256

public String getEncryptionKeySha256()

Gets the SHA256 of the encryption key used to encrypt the path.

Returns:

the key used to encrypt the path

getEncryptionScope

public String getEncryptionScope()

Gets the path's encryption scope.

Returns:

the path's encryption scope.

getETag

public String getETag()

Gets the eTag of the path.

Returns:

the eTag of the path

getExpiresOn

public OffsetDateTime getExpiresOn()

Gets the time when the path is going to expire.

Returns:

the time when the path is going to expire.

getFileSize

public long getFileSize()

Gets the size of the path in bytes.

Returns:

the size of the path in bytes

getGroup

public String getGroup()

Get the group property of the path: The owner property.

Returns:

the group value.

getLastModified

public OffsetDateTime getLastModified()

Gets the time when the path was last modified.

Returns:

the time when the path was last modified

getLeaseDuration

public LeaseDurationType getLeaseDuration()

Gets the lease duration if the path is leased.

Returns:

the lease duration if the path is leased

getLeaseState

public LeaseStateType getLeaseState()

Gets the lease state of the path.

Returns:

the lease state of the path

getLeaseStatus

public LeaseStatusType getLeaseStatus()

Gets the lease status of the path.

Returns:

the lease status of the path

getMetadata

public Map getMetadata()

Gets the metadata associated to this path.

Returns:

the metadata associated to this path

getOwner

public String getOwner()

Get the owner property of the path: The owner property.

Returns:

the owner value.

getPermissions

public String getPermissions()

Get the permissions property of the path: The permissions property.

Returns:

the permissions value.

isDirectory

public Boolean isDirectory()

Gets whether this path represents a directory.

Returns:

whether this path represents a directory

isIncrementalCopy

public Boolean isIncrementalCopy()

Gets the status of the path being an incremental copy file.

Returns:

the status of the path being an incremental copy file

isServerEncrypted

public Boolean isServerEncrypted()

Gets the status of the path being encrypted on the server.

Returns:

the status of the path being encrypted on the server