Package com.azure.search.documents.models

Class IndexingResult

java.lang.Object

com.azure.search.documents.models.IndexingResult

All Implemented Interfaces:

Serializable

public final class IndexingResult
extends Object
implements Serializable

Status of an indexing operation for a single document.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IndexingResult(String key, boolean succeeded, int statusCode)	Constructor of IndexingResult.

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()	Get the errorMessage property: The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.
String	getKey()	Get the key property: The key of a document that was in the indexing request.
int	getStatusCode()	Get the statusCode property: The status code of the indexing operation.
boolean	isSucceeded()	Get the succeeded property: A value indicating whether the indexing operation succeeded for the document identified by the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexingResult

public IndexingResult(String key,
                      boolean succeeded,
                      int statusCode)

Constructor of IndexingResult.

Parameters:

key - The key of a document that was in the indexing request.

succeeded - The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.

statusCode - The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.

Method Detail

getKey

public String getKey()

Get the key property: The key of a document that was in the indexing request.

Returns:

the key value.

getErrorMessage

public String getErrorMessage()

Get the errorMessage property: The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.

Returns:

the errorMessage value.

isSucceeded

public boolean isSucceeded()

Get the succeeded property: A value indicating whether the indexing operation succeeded for the document identified by the key.

Returns:

the succeeded value.

getStatusCode

public int getStatusCode()

Get the statusCode property: The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.

Returns:

the statusCode value.