FileSetExpiryOptions interface

Package:

@azure/storage-file-datalake

Option interface for the setExpiry operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
expiresOn	The time to set the file to expire on, used in combination with the "Absolute" FileExpiryMode. A time in the past is not allowed and milliseconds will be dropped.
timeToExpireInMs	The number of milliseconds to elapse before the file expires, used in combination with the "RelativeToCreation" or "RelativeToNow" FileExpiryMode.

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

expiresOn

The time to set the file to expire on, used in combination with the "Absolute" FileExpiryMode. A time in the past is not allowed and milliseconds will be dropped.

expiresOn?: Date

Property Value

Date

timeToExpireInMs

The number of milliseconds to elapse before the file expires, used in combination with the "RelativeToCreation" or "RelativeToNow" FileExpiryMode.

timeToExpireInMs?: number

Property Value

number

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions