KnowledgeSourceStatus Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.knowledgebases.models.KnowledgeSourceStatus

Implements

JsonSerializable<KnowledgeSourceStatus>

public final class KnowledgeSourceStatus
implements JsonSerializable<KnowledgeSourceStatus>

Represents the status and synchronization history of a knowledge source.

Constructor Summary

Constructor Description
KnowledgeSourceStatus(KnowledgeSourceSynchronizationStatus synchronizationStatus)

Creates an instance of KnowledgeSourceStatus class.

Method Summary

Modifier and Type Method and Description
static KnowledgeSourceStatus fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceStatus from the JsonReader.
SynchronizationState getCurrentSynchronizationState()

Get the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.
KnowledgeSourceKind getKind()

Get the kind property: Identifies the Knowledge Source kind directly from the Status response.
CompletedSynchronizationState getLastSynchronizationState()

Get the lastSynchronizationState property: Details of the last completed synchronization.
KnowledgeSourceStatistics getStatistics()

Get the statistics property: Statistical information about the knowledge source synchronization history.
Duration getSynchronizationInterval()

Get the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily).
KnowledgeSourceSynchronizationStatus getSynchronizationStatus()

Get the synchronizationStatus property: The current synchronization status.
KnowledgeSourceStatus setCurrentSynchronizationState(SynchronizationState currentSynchronizationState)

Set the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.
KnowledgeSourceStatus setKind(KnowledgeSourceKind kind)

Set the kind property: Identifies the Knowledge Source kind directly from the Status response.
KnowledgeSourceStatus setLastSynchronizationState(CompletedSynchronizationState lastSynchronizationState)

Set the lastSynchronizationState property: Details of the last completed synchronization.
KnowledgeSourceStatus setStatistics(KnowledgeSourceStatistics statistics)

Set the statistics property: Statistical information about the knowledge source synchronization history.
KnowledgeSourceStatus setSynchronizationInterval(Duration synchronizationInterval)

Set the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily).
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeSourceStatus

public KnowledgeSourceStatus(KnowledgeSourceSynchronizationStatus synchronizationStatus)

Creates an instance of KnowledgeSourceStatus class.

Parameters:

synchronizationStatus - the synchronizationStatus value to set.

Method Details

fromJson

public static KnowledgeSourceStatus fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceStatus from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeSourceStatus if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getCurrentSynchronizationState

public SynchronizationState getCurrentSynchronizationState()

Get the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.

Returns:

the currentSynchronizationState value.

getKind

public KnowledgeSourceKind getKind()

Get the kind property: Identifies the Knowledge Source kind directly from the Status response.

Returns:

the kind value.

getLastSynchronizationState

public CompletedSynchronizationState getLastSynchronizationState()

Get the lastSynchronizationState property: Details of the last completed synchronization. Null on first sync.

Returns:

the lastSynchronizationState value.

getStatistics

public KnowledgeSourceStatistics getStatistics()

Get the statistics property: Statistical information about the knowledge source synchronization history. Null on first sync.

Returns:

the statistics value.

getSynchronizationInterval

public Duration getSynchronizationInterval()

Get the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.

Returns:

the synchronizationInterval value.

getSynchronizationStatus

public KnowledgeSourceSynchronizationStatus getSynchronizationStatus()

Get the synchronizationStatus property: The current synchronization status.

Returns:

the synchronizationStatus value.

setCurrentSynchronizationState

public KnowledgeSourceStatus setCurrentSynchronizationState(SynchronizationState currentSynchronizationState)

Set the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.

Parameters:

currentSynchronizationState - the currentSynchronizationState value to set.

Returns:

the KnowledgeSourceStatus object itself.

setKind

public KnowledgeSourceStatus setKind(KnowledgeSourceKind kind)

Set the kind property: Identifies the Knowledge Source kind directly from the Status response.

Parameters:

kind - the kind value to set.

Returns:

the KnowledgeSourceStatus object itself.

setLastSynchronizationState

public KnowledgeSourceStatus setLastSynchronizationState(CompletedSynchronizationState lastSynchronizationState)

Set the lastSynchronizationState property: Details of the last completed synchronization. Null on first sync.

Parameters:

lastSynchronizationState - the lastSynchronizationState value to set.

Returns:

the KnowledgeSourceStatus object itself.

setStatistics

public KnowledgeSourceStatus setStatistics(KnowledgeSourceStatistics statistics)

Set the statistics property: Statistical information about the knowledge source synchronization history. Null on first sync.

Parameters:

statistics - the statistics value to set.

Returns:

the KnowledgeSourceStatus object itself.

setSynchronizationInterval

public KnowledgeSourceStatus setSynchronizationInterval(Duration synchronizationInterval)

Set the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.

Parameters:

synchronizationInterval - the synchronizationInterval value to set.

Returns:

the KnowledgeSourceStatus object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to