Share via

SearchIndexerError Class

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

Implements

JsonSerializable<SearchIndexerError>

public final class SearchIndexerError
implements JsonSerializable<SearchIndexerError>

Represents an item- or document-level indexing error.

Constructor Summary

Constructor Description
SearchIndexerError(String errorMessage, int statusCode)

Creates an instance of SearchIndexerError class.

Method Summary

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

Reads an instance of SearchIndexerError from the JsonReader.
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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

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 Details

fromJson

public static SearchIndexerError fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerError from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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.

getErrorMessage

public String getErrorMessage()

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

Returns:

the errorMessage value.

getKey

public String getKey()

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

Returns:

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

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to