DeleteTaskFileOptionalParams interface
Optional parameters.
- Extends
Properties
| client |
The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
| ocp |
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. |
| recursive | Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. |
| return |
Whether the server should return the client-request-id in the response. |
| timeout |
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
clientRequestId
The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
clientRequestId?: stringProperty Value
string
ocpDate
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
ocpDate?: DateProperty Value
Date
recursive
Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.
recursive?: booleanProperty Value
boolean
returnClientRequestId
Whether the server should return the client-request-id in the response.
returnClientRequestId?: booleanProperty Value
boolean
timeoutInSeconds
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
timeoutInSeconds?: numberProperty Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallbackProperty Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From OperationOptions.tracingOptions