Share via

IndexerExecutionResult Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.5
  • java.lang.Object
    • com.azure.search.documents.indexes.models.IndexerExecutionResult

Implements

JsonSerializable<IndexerExecutionResult>

public final class IndexerExecutionResult
implements JsonSerializable<IndexerExecutionResult>

Represents the result of an individual indexer execution.

Constructor Summary

Constructor Description
IndexerExecutionResult(IndexerExecutionStatus status, List<SearchIndexerError> errors, List<SearchIndexerWarning> warnings, int itemCount, int failedItemCount)

Creates an instance of IndexerExecutionResult class.

Method Summary

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

Reads an instance of IndexerExecutionResult from the JsonReader.
OffsetDateTime getEndTime()

Get the endTime property: The end time of this indexer execution, if the execution has already completed.
String getErrorMessage()

Get the errorMessage property: The error message indicating the top-level error, if any.
List<SearchIndexerError> getErrors()

Get the errors property: The item-level indexing errors.
int getFailedItemCount()

Get the failedItemCount property: The number of items that failed to be indexed during this indexer execution.
String getFinalTrackingState()

Get the finalTrackingState property: Change tracking state with which an indexer execution finished.
String getInitialTrackingState()

Get the initialTrackingState property: Change tracking state with which an indexer execution started.
int getItemCount()

Get the itemCount property: The number of items that were processed during this indexer execution.
OffsetDateTime getStartTime()

Get the startTime property: The start time of this indexer execution.
IndexerExecutionStatus getStatus()

Get the status property: The outcome of this indexer execution.
List<SearchIndexerWarning> getWarnings()

Get the warnings property: The item-level indexing warnings.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IndexerExecutionResult

public IndexerExecutionResult(IndexerExecutionStatus status, List errors, List warnings, int itemCount, int failedItemCount)

Creates an instance of IndexerExecutionResult class.

Parameters:

status - the status value to set.
errors - the errors value to set.
warnings - the warnings value to set.
itemCount - the itemCount value to set.
failedItemCount - the failedItemCount value to set.

Method Details

fromJson

public static IndexerExecutionResult fromJson(JsonReader jsonReader)

Reads an instance of IndexerExecutionResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getEndTime

public OffsetDateTime getEndTime()

Get the endTime property: The end time of this indexer execution, if the execution has already completed.

Returns:

the endTime value.

getErrorMessage

public String getErrorMessage()

Get the errorMessage property: The error message indicating the top-level error, if any.

Returns:

the errorMessage value.

getErrors

public List getErrors()

Get the errors property: The item-level indexing errors.

Returns:

the errors value.

getFailedItemCount

public int getFailedItemCount()

Get the failedItemCount property: The number of items that failed to be indexed during this indexer execution.

Returns:

the failedItemCount value.

getFinalTrackingState

public String getFinalTrackingState()

Get the finalTrackingState property: Change tracking state with which an indexer execution finished.

Returns:

the finalTrackingState value.

getInitialTrackingState

public String getInitialTrackingState()

Get the initialTrackingState property: Change tracking state with which an indexer execution started.

Returns:

the initialTrackingState value.

getItemCount

public int getItemCount()

Get the itemCount property: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed.

Returns:

the itemCount value.

getStartTime

public OffsetDateTime getStartTime()

Get the startTime property: The start time of this indexer execution.

Returns:

the startTime value.

getStatus

public IndexerExecutionStatus getStatus()

Get the status property: The outcome of this indexer execution.

Returns:

the status value.

getWarnings

public List getWarnings()

Get the warnings property: The item-level indexing warnings.

Returns:

the warnings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to