SynchronizationState Class

Definition

Represents the current state of an ongoing synchronization that spans multiple indexer runs.

public class SynchronizationState : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.SynchronizationState>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.SynchronizationState>
type SynchronizationState = class
    interface IJsonModel<SynchronizationState>
    interface IPersistableModel<SynchronizationState>
Public Class SynchronizationState
Implements IJsonModel(Of SynchronizationState), IPersistableModel(Of SynchronizationState)
Inheritance
SynchronizationState
Implements

Constructors

Name Description
SynchronizationState(DateTimeOffset, Int32, Int32, Int32)

Initializes a new instance of SynchronizationState.

Properties

Name Description
Errors

Collection of document-level indexing errors encountered during the current synchronization run. Returned only when errors are present.

ItemsSkipped

The number of items skipped in the current synchronization.

ItemsUpdatesFailed

The number of item updates that failed in the current synchronization.

ItemsUpdatesProcessed

The number of item updates successfully processed in the current synchronization.

StartTime

The start time of the current synchronization.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SynchronizationState>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SynchronizationState>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SynchronizationState>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SynchronizationState>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SynchronizationState>.Write(ModelReaderWriterOptions)

Applies to