PathUpdateHeaders interface

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

Defines headers for Path_update operation.

Properties

acceptRanges

Indicates that the service supports requests for partial file content.
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

An MD5 hash of the request content. This header is only returned for "Flush" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.
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.
lastModified

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

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

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

When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.

Property Details

acceptRanges

Indicates that the service supports requests for partial file content.

acceptRanges?: 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

An MD5 hash of the request content. This header is only returned for "Flush" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.

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

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

properties

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

version

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

version?: string

Property Value

string

xMsContinuation

When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.

xMsContinuation?: string

Property Value

string