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

Class SearchIndexerWarning

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerWarning
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerWarning>
public final class SearchIndexerWarning extends Object implements com.azure.json.JsonSerializable<SearchIndexerWarning>
Represents an item-level warning.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchIndexerWarning(String message)
    Creates an instance of SearchIndexerWarning class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SearchIndexerWarning
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • SearchIndexerWarning

      public SearchIndexerWarning(String message)
      Creates an instance of SearchIndexerWarning class.
      Parameters:
      message - the message value to set.

  • Method Details

    • 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.

    • 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SearchIndexerWarning>
      Throws:
      IOException

    • fromJson

      public static SearchIndexerWarning fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the SearchIndexerWarning.