Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathReadHeaders

Package version

Defines headers for Path_read operation.

Hierarchy

  • PathReadHeaders

Index

Properties

Optional acceptRanges

acceptRanges: undefined | string

Indicates that the service supports requests for partial file content.

Optional cacheControl

cacheControl: undefined | string

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

Optional contentDisposition

contentDisposition: undefined | string

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

Optional contentEncoding

contentEncoding: undefined | string

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

Optional contentLanguage

contentLanguage: undefined | string

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

Optional contentLength

contentLength: undefined | number

The size of the resource in bytes.

Optional contentMD5

contentMD5: undefined | string

The MD5 hash of complete file. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned so that the client can check for message content integrity.

Optional contentRange

contentRange: undefined | string

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

Optional contentType

contentType: undefined | string

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

Optional date

date: Date

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

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional etag

etag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

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

Optional leaseDuration

leaseDuration: undefined | string

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

Optional leaseState

leaseState: undefined | string

Lease state of the resource.

Optional leaseStatus

leaseStatus: undefined | string

The lease status of the resource.

Optional properties

properties: undefined | string

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.

Optional requestId

requestId: undefined | string

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

Optional resourceType

resourceType: undefined | string

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

Optional version

version: undefined | string

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

Generated using TypeDoc