Share via

ResetDocumentsOptions interface

Package:
@azure/search-documents

Options for reset docs operation.

Extends
OperationOptions

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.

Inherited Properties

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.
serializerOptions

Options to override serialization/de-serialization behavior.
tracingOptions

Options used when tracing is enabled.

Property Details

datasourceDocumentIds

datasource document identifiers to be reset

datasourceDocumentIds?: string[]

Property Value

string[]

documentKeys

document keys to be reset

documentKeys?: string[]

Property Value

string[]

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.

overwrite?: boolean

Property Value

boolean

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

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

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions