Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathGetPropertiesHeaders

Package version

Defines headers for Path_getProperties operation.

Hierarchy

  • PathGetPropertiesHeaders

Index

Properties

Optional acceptRanges

acceptRanges: undefined | string

Indicates that the service supports requests for partial file content.

Optional accessTier

accessTier: undefined | string

Optional accessTierChangedOn

accessTierChangedOn: Date

Optional accessTierInferred

accessTierInferred: undefined | false | true

Optional acl

acl: undefined | string

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.

Optional archiveStatus

archiveStatus: undefined | string

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 clientRequestId

clientRequestId: undefined | string

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: Uint8Array

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.

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 copyCompletedOn

copyCompletedOn: Date

Optional copyId

copyId: undefined | string

Optional copyProgress

copyProgress: undefined | string

Optional copySource

copySource: undefined | string

Optional copyStatus

copyStatus: CopyStatusType

Optional copyStatusDescription

copyStatusDescription: undefined | string

Optional createdOn

createdOn: Date

Optional date

date: Date

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

Optional destinationSnapshot

destinationSnapshot: undefined | string

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

Optional errorCode

errorCode: undefined | string

Error Code

Optional etag

etag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional expiresOn

expiresOn: Date

The time the file will expire.

Optional group

group: undefined | string

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

Optional isIncrementalCopy

isIncrementalCopy: undefined | false | true

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

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: LeaseDurationType

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

Optional leaseState

leaseState: LeaseStateType

Lease state of the resource.

Optional leaseStatus

leaseStatus: LeaseStatusType

The lease status of the resource.

Optional metadata

metadata: Metadata

Optional owner

owner: undefined | string

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

Optional permissions

permissions: undefined | string

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.

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