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

Class SearchIndexerError

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerError

public final class SearchIndexerError
extends Object

Represents an item- or document-level indexing error.

Constructor Summary

Constructors

Constructor	Description
SearchIndexerError(String errorMessage, int statusCode)	Creates an instance of SearchIndexerError class.

Method Summary

Modifier and Type	Method	Description
String	getDetails()	Get the details property: Additional, verbose details about the error to assist in debugging the indexer.
String	getDocumentationLink()	Get the documentationLink property: A link to a troubleshooting guide for these classes of errors.
String	getErrorMessage()	Get the errorMessage property: The message describing the error that occurred while processing the item.
String	getKey()	Get the key property: The key of the item for which indexing failed.
String	getName()	Get the name property: The name of the source at which the error originated.
int	getStatusCode()	Get the statusCode property: The status code indicating why the indexing operation failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchIndexerError

public SearchIndexerError(String errorMessage,
                          int statusCode)

Creates an instance of SearchIndexerError class.

Parameters:

errorMessage - the errorMessage value to set.

statusCode - the statusCode value to set.

Method Detail

getKey

public String getKey()

Get the key property: The key of the item for which indexing failed.

Returns:

the key value.

getErrorMessage

public String getErrorMessage()

Get the errorMessage property: The message describing the error that occurred while processing the item.

Returns:

the errorMessage value.

getStatusCode

public int getStatusCode()

Get the statusCode property: The status code indicating why the indexing operation failed. Possible values include: 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.

getName

public String getName()

Get the name property: The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.

Returns:

the name value.

getDetails

public String getDetails()

Get the details property: Additional, verbose details about the error to assist in debugging the indexer. This may not be always available.

Returns:

the details value.

getDocumentationLink

public String getDocumentationLink()

Get the documentationLink property: A link to a troubleshooting guide for these classes of errors. This may not be always available.

Returns:

the documentationLink value.