com.azure.search.documents.indexes.models.SearchSuggester.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SearchSuggester"
fullName: "com.azure.search.documents.indexes.models.SearchSuggester"
name: "SearchSuggester"
nameWithType: "SearchSuggester"
summary: "Defines how the Suggest API should apply to a group of fields in the index."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SearchSuggester**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SearchSuggester?alt=com.azure.search.documents.indexes.models.SearchSuggester&text=SearchSuggester\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.SearchSuggester(java.lang.String,java.util.List<java.lang.String>)"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.SearchSuggester(String name, List<String> sourceFields)"
  name: "SearchSuggester(String name, List<String> sourceFields)"
  nameWithType: "SearchSuggester.SearchSuggester(String name, List<String> sourceFields)"
  summary: "Creates an instance of Search<wbr>Suggester class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the sourceFields value to set."
    name: "sourceFields"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public SearchSuggester(String name, List<String> sourceFields)"
  desc: "Creates an instance of SearchSuggester class."
methods:
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "SearchSuggester.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Search<wbr>Suggester from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static SearchSuggester fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of SearchSuggester from the JsonReader."
  returns:
    description: "An instance of SearchSuggester if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchSuggester?alt=com.azure.search.documents.indexes.models.SearchSuggester&text=SearchSuggester\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.getName()"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.getName()"
  name: "getName()"
  nameWithType: "SearchSuggester.getName()"
  summary: "Get the name property: The name of the suggester."
  syntax: "public String getName()"
  desc: "Get the name property: The name of the suggester."
  returns:
    description: "the name value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.getSearchMode()"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.getSearchMode()"
  name: "getSearchMode()"
  nameWithType: "SearchSuggester.getSearchMode()"
  summary: "Get the search<wbr>Mode property: A value indicating the capabilities of the suggester."
  syntax: "public String getSearchMode()"
  desc: "Get the searchMode property: A value indicating the capabilities of the suggester."
  returns:
    description: "the searchMode value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.getSourceFields()"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.getSourceFields()"
  name: "getSourceFields()"
  nameWithType: "SearchSuggester.getSourceFields()"
  summary: "Get the source<wbr>Fields property: The list of field names to which the suggester applies."
  syntax: "public List<String> getSourceFields()"
  desc: "Get the sourceFields property: The list of field names to which the suggester applies. Each field must be searchable."
  returns:
    description: "the sourceFields value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.search.documents.indexes.models.SearchSuggester.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.SearchSuggester.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "SearchSuggester.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines how the Suggest API should apply to a group of fields in the index."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SearchSuggester?alt=com.azure.search.documents.indexes.models.SearchSuggester&text=SearchSuggester\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.1