Package com.azure.search.documents.indexes.models

Class IndexerExecutionResult

java.lang.Object

com.azure.search.documents.indexes.models.IndexerExecutionResult

public final class IndexerExecutionResult
extends Object

Represents the result of an individual indexer execution.

Constructor Summary

Constructors

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	Description
IndexerCurrentState	getCurrentState()	Get the currentState property: All of the state that defines and dictates the indexer's current execution.
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.
IndexerExecutionStatusDetail	getStatusDetail()	Get the statusDetail property: The outcome of this indexer execution.
List<SearchIndexerWarning>	getWarnings()	Get the warnings property: The item-level indexing warnings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexerExecutionResult

public IndexerExecutionResult(IndexerExecutionStatus status,
                              List<SearchIndexerError> errors,
                              List<SearchIndexerWarning> 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 Detail

getStatus

public IndexerExecutionStatus getStatus()

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

Returns:

the status value.

getStatusDetail

public IndexerExecutionStatusDetail getStatusDetail()

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

Returns:

the statusDetail value.

getCurrentState

public IndexerCurrentState getCurrentState()

Get the currentState property: All of the state that defines and dictates the indexer's current execution.

Returns:

the currentState value.

getErrorMessage

public String getErrorMessage()

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

Returns:

the errorMessage value.

getStartTime

public OffsetDateTime getStartTime()

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

Returns:

the startTime value.

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.

getErrors

public List<SearchIndexerError> getErrors()

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

Returns:

the errors value.

getWarnings

public List<SearchIndexerWarning> getWarnings()

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

Returns:

the warnings 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.

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.

getInitialTrackingState

public String getInitialTrackingState()

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

Returns:

the initialTrackingState value.

getFinalTrackingState

public String getFinalTrackingState()

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

Returns:

the finalTrackingState value.