Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileSetExpiryOptions

Package version

Option interface for the DataLakeFileClient.setExpiry operation.

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

Optional expiresOn

expiresOn: Date

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

Optional timeToExpireInMs

timeToExpireInMs: undefined | number

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

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc