SearchIndexingBufferedSenderOptions<T> Class

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

Source:

SearchIndexingBufferedSenderOptions.cs

Provides the configuration options for SearchIndexingBufferedSender<T>.

public class SearchIndexingBufferedSenderOptions<T>

type SearchIndexingBufferedSenderOptions<'T> = class

Public Class SearchIndexingBufferedSenderOptions(Of T)

Type Parameters

T

The .NET type that maps to the index schema. Instances of this type can be retrieved as documents from the index.

Inheritance

Object

SearchIndexingBufferedSenderOptions<T>

Constructors

SearchIndexingBufferedSenderOptions<T>()

Properties

AutoFlush	Gets or sets a value indicating whether the sender should automatically flush any indexing actions that have been added. This will happen when the batch is full or when the AutoFlushInterval has elapsed. The default value is true.
AutoFlushInterval	Gets or sets an optional amount of time to wait before automatically flushing any remaining indexing actions. The default value is 60 seconds.
FlushCancellationToken	Gets or sets a CancellationToken to use when submitting indexing actions.
InitialBatchActionCount	Gets or sets a value indicating the initial number of actions to group into a batch when tuning the behavior of the sender. The default value will be 512 if unset. The current service maximum is 32000.
KeyFieldAccessor	Gets or sets a function that can be used to access the index key value of a document. Any indexing errors are identified by key and you can use this function to provide that mapping. Otherwise we will look for IsKey or call GetIndex(String, CancellationToken) to help automatically determine the key.
MaxRetriesPerIndexAction	Gets or sets the number of times to retry a failed document. Note that this is different than MaxRetries which will try to resend the same request. This property is used to control the number of attempts we will make to submit an indexing action.
MaxThrottlingDelay	The maximum permissible delay between retry attempts. Note that this is different than MaxDelay which will only delay before resending the same request. This property is used to add delay between additional batch submissions when our requests are being throttled by the service.
ThrottlingDelay	The initial retry delay. The delay will increase exponentially with subsequent retries and add random jitter. Note that this is different than Delay which will only delay before resending the same request. This property is used to add delay between additional batch submissions when our requests are being throttled by the service.