PathReadOptionalParams | @azure/storage-datalake

Optional Parameters.

Hierarchy

any
- PathReadOptionalParams

Index

Properties

Optional ifMatch

ifMatch: undefined | string

Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.

Optional ifModifiedSince

ifModifiedSince: undefined | string

Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.

Optional ifUnmodifiedSince

ifUnmodifiedSince: undefined | string

Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.

Optional range

range: undefined | string

The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.

Optional timeoutParameter

timeoutParameter: undefined | number

An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.

Optional xMsClientRequestId

xMsClientRequestId: undefined | string

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

Optional xMsDate

xMsDate: undefined | string

Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

Optional xMsLeaseId

xMsLeaseId: undefined | string

Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.

Optional xMsRangeGetContentMd5

xMsRangeGetContentMd5: undefined | false | true

Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).