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

Implements

JsonSerializable<KnowledgeSourceStatistics>

public final class KnowledgeSourceStatistics
implements JsonSerializable<KnowledgeSourceStatistics>

Statistical information about knowledge source synchronization history.

Constructor Summary

Constructor Description
KnowledgeSourceStatistics(int totalSynchronization, Duration averageSynchronizationDuration, int averageItemsProcessedPerSynchronization)

Creates an instance of KnowledgeSourceStatistics class.

Method Summary

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

Reads an instance of KnowledgeSourceStatistics from the JsonReader.
int getAverageItemsProcessedPerSynchronization()

Get the averageItemsProcessedPerSynchronization property: Average items processed per synchronization.
Duration getAverageSynchronizationDuration()

Get the averageSynchronizationDuration property: Average synchronization duration in HH:MM:SS format.
int getTotalSynchronization()

Get the totalSynchronization property: Total number of synchronizations.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeSourceStatistics

public KnowledgeSourceStatistics(int totalSynchronization, Duration averageSynchronizationDuration, int averageItemsProcessedPerSynchronization)

Creates an instance of KnowledgeSourceStatistics class.

Parameters:

totalSynchronization - the totalSynchronization value to set.
averageSynchronizationDuration - the averageSynchronizationDuration value to set.
averageItemsProcessedPerSynchronization - the averageItemsProcessedPerSynchronization value to set.

Method Details

fromJson

public static KnowledgeSourceStatistics fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceStatistics from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeSourceStatistics 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.

getAverageItemsProcessedPerSynchronization

public int getAverageItemsProcessedPerSynchronization()

Get the averageItemsProcessedPerSynchronization property: Average items processed per synchronization.

Returns:

the averageItemsProcessedPerSynchronization value.

getAverageSynchronizationDuration

public Duration getAverageSynchronizationDuration()

Get the averageSynchronizationDuration property: Average synchronization duration in HH:MM:SS format.

Returns:

the averageSynchronizationDuration value.

getTotalSynchronization

public int getTotalSynchronization()

Get the totalSynchronization property: Total number of synchronizations.

Returns:

the totalSynchronization value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to