ResetDocumentsOptions interface

Options for reset documents operation.

Properties

dataSourceDocumentIds	Datasource document identifiers to be reset.
documentKeys	Document keys to be reset.
overwrite	If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested.

abortSignal	The signal which can be used to abort requests.
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.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Datasource document identifiers to be reset.

dataSourceDocumentIds?: string[]

string[]

Document keys to be reset.

documentKeys?: string[]

string[]

If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested.

overwrite?: boolean

boolean

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Inherited From OperationOptions.abortSignal

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?: RawResponseCallback

Inherited From OperationOptions.onResponse

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Inherited From OperationOptions.requestOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Inherited From OperationOptions.tracingOptions

Was this page helpful?