Share via

SearchIndexerWarning Class

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

Implements

JsonSerializable<SearchIndexerWarning>

public final class SearchIndexerWarning
implements JsonSerializable<SearchIndexerWarning>

Represents an item-level warning.

Constructor Summary

Constructor Description
SearchIndexerWarning(String message)

Creates an instance of SearchIndexerWarning class.

Method Summary

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

Reads an instance of SearchIndexerWarning from the JsonReader.
String getDetails()

Get the details property: Additional, verbose details about the warning to assist in debugging the indexer.
String getDocumentationLink()

Get the documentationLink property: A link to a troubleshooting guide for these classes of warnings.
String getKey()

Get the key property: The key of the item which generated a warning.
String getMessage()

Get the message property: The message describing the warning that occurred while processing the item.
String getName()

Get the name property: The name of the source at which the warning originated.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexerWarning

public SearchIndexerWarning(String message)

Creates an instance of SearchIndexerWarning class.

Parameters:

message - the message value to set.

Method Details

fromJson

public static SearchIndexerWarning fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerWarning from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexerWarning 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 warning 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 warnings. This may not be always available.

Returns:

the documentationLink value.

getKey

public String getKey()

Get the key property: The key of the item which generated a warning.

Returns:

the key value.

getMessage

public String getMessage()

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

Returns:

the message value.

getName

public String getName()

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

Returns:

the name value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to