Share via

PathGetPropertiesHeadersModel interface

  • Reference
Package:
@azure/storage-file-datalake

Defines headers for Path_getProperties operation.

Properties

acceptRanges

Indicates that the service supports requests for partial file content.
acl

The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account.
cacheControl

If the Cache-Control request header has previously been set for the resource, that value is returned in this header.
contentDisposition

If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.
contentEncoding

If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.
contentLanguage

If the Content-Language request header has previously been set for the resource, that value is returned in this header.
contentLength

The size of the resource in bytes.
contentMD5

The MD5 hash of complete file stored in storage. This header is returned only for "GetProperties" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity.
contentRange

Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.
contentType

The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.
date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.
errorCode

Error Code
etag

An HTTP entity tag associated with the file or directory.
group

The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.
lastModified

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.
leaseDuration

When a resource is leased, specifies whether the lease is of infinite or fixed duration.
leaseState

Lease state of the resource.
leaseStatus

The lease status of the resource.
owner

The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.
permissions

The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.
properties

The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
requestId

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.
resourceType

The type of the resource. The value may be "file" or "directory". If not set, the value is "file".
version

The version of the REST protocol used to process the request.

Property Details

acceptRanges

Indicates that the service supports requests for partial file content.

acceptRanges?: string

Property Value

string

acl

The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account.

acl?: string

Property Value

string

cacheControl

If the Cache-Control request header has previously been set for the resource, that value is returned in this header.

cacheControl?: string

Property Value

string

contentDisposition

If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.

contentDisposition?: string

Property Value

string

contentEncoding

If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.

contentEncoding?: string

Property Value

string

contentLanguage

If the Content-Language request header has previously been set for the resource, that value is returned in this header.

contentLanguage?: string

Property Value

string

contentLength

The size of the resource in bytes.

contentLength?: number

Property Value

number

contentMD5

The MD5 hash of complete file stored in storage. This header is returned only for "GetProperties" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity.

contentMD5?: string

Property Value

string

contentRange

Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.

contentRange?: string

Property Value

string

contentType

The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.

contentType?: string

Property Value

string

date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

date?: Date

Property Value

Date

errorCode

Error Code

errorCode?: string

Property Value

string

etag

An HTTP entity tag associated with the file or directory.

etag?: string

Property Value

string

group

The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

group?: string

Property Value

string

lastModified

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

lastModified?: Date

Property Value

Date

leaseDuration

When a resource is leased, specifies whether the lease is of infinite or fixed duration.

leaseDuration?: string

Property Value

string

leaseState

Lease state of the resource.

leaseState?: string

Property Value

string

leaseStatus

The lease status of the resource.

leaseStatus?: string

Property Value

string

owner

The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

owner?: string

Property Value

string

permissions

The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.

permissions?: string

Property Value

string

properties

The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.

properties?: string

Property Value

string

requestId

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

requestId?: string

Property Value

string

resourceType

The type of the resource. The value may be "file" or "directory". If not set, the value is "file".

resourceType?: string

Property Value

string

version

The version of the REST protocol used to process the request.

version?: string

Property Value

string