azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents....

157 строки
11 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.CustomEntityAlias"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias"
name: "CustomEntityAlias"
nameWithType: "CustomEntityAlias"
summary: "A complex object that can be used to specify alternative spellings or synonyms to the root entity name."
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 **CustomEntityAlias**</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.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.CustomEntityAlias(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.CustomEntityAlias(String text)"
name: "CustomEntityAlias(String text)"
nameWithType: "CustomEntityAlias.CustomEntityAlias(String text)"
summary: "Creates an instance of Custom<wbr>Entity<wbr>Alias class."
parameters:
- description: "the text value to set."
name: "text"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CustomEntityAlias(String text)"
desc: "Creates an instance of CustomEntityAlias class."
methods:
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "CustomEntityAlias.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Custom<wbr>Entity<wbr>Alias 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 CustomEntityAlias 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 CustomEntityAlias from the JsonReader."
returns:
description: "An instance of CustomEntityAlias 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.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.getFuzzyEditDistance()"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.getFuzzyEditDistance()"
name: "getFuzzyEditDistance()"
nameWithType: "CustomEntityAlias.getFuzzyEditDistance()"
summary: "Get the fuzzy<wbr>Edit<wbr>Distance property: Determine the fuzzy edit distance of the alias."
syntax: "public Integer getFuzzyEditDistance()"
desc: "Get the fuzzyEditDistance property: Determine the fuzzy edit distance of the alias."
returns:
description: "the fuzzyEditDistance value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.getText()"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.getText()"
name: "getText()"
nameWithType: "CustomEntityAlias.getText()"
summary: "Get the text property: The text of the alias."
syntax: "public String getText()"
desc: "Get the text property: The text of the alias."
returns:
description: "the text 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.CustomEntityAlias.isAccentSensitive()"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.isAccentSensitive()"
name: "isAccentSensitive()"
nameWithType: "CustomEntityAlias.isAccentSensitive()"
summary: "Get the accent<wbr>Sensitive property: Determine if the alias is accent sensitive."
syntax: "public Boolean isAccentSensitive()"
desc: "Get the accentSensitive property: Determine if the alias is accent sensitive."
returns:
description: "the accentSensitive value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.isCaseSensitive()"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.isCaseSensitive()"
name: "isCaseSensitive()"
nameWithType: "CustomEntityAlias.isCaseSensitive()"
summary: "Get the case<wbr>Sensitive property: Determine if the alias is case sensitive."
syntax: "public Boolean isCaseSensitive()"
desc: "Get the caseSensitive property: Determine if the alias is case sensitive."
returns:
description: "the caseSensitive value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.setAccentSensitive(java.lang.Boolean)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.setAccentSensitive(Boolean accentSensitive)"
name: "setAccentSensitive(Boolean accentSensitive)"
nameWithType: "CustomEntityAlias.setAccentSensitive(Boolean accentSensitive)"
summary: "Set the accent<wbr>Sensitive property: Determine if the alias is accent sensitive."
parameters:
- description: "the accentSensitive value to set."
name: "accentSensitive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public CustomEntityAlias setAccentSensitive(Boolean accentSensitive)"
desc: "Set the accentSensitive property: Determine if the alias is accent sensitive."
returns:
description: "the CustomEntityAlias object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.setCaseSensitive(java.lang.Boolean)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.setCaseSensitive(Boolean caseSensitive)"
name: "setCaseSensitive(Boolean caseSensitive)"
nameWithType: "CustomEntityAlias.setCaseSensitive(Boolean caseSensitive)"
summary: "Set the case<wbr>Sensitive property: Determine if the alias is case sensitive."
parameters:
- description: "the caseSensitive value to set."
name: "caseSensitive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public CustomEntityAlias setCaseSensitive(Boolean caseSensitive)"
desc: "Set the caseSensitive property: Determine if the alias is case sensitive."
returns:
description: "the CustomEntityAlias object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.setFuzzyEditDistance(java.lang.Integer)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.setFuzzyEditDistance(Integer fuzzyEditDistance)"
name: "setFuzzyEditDistance(Integer fuzzyEditDistance)"
nameWithType: "CustomEntityAlias.setFuzzyEditDistance(Integer fuzzyEditDistance)"
summary: "Set the fuzzy<wbr>Edit<wbr>Distance property: Determine the fuzzy edit distance of the alias."
parameters:
- description: "the fuzzyEditDistance value to set."
name: "fuzzyEditDistance"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public CustomEntityAlias setFuzzyEditDistance(Integer fuzzyEditDistance)"
desc: "Set the fuzzyEditDistance property: Determine the fuzzy edit distance of the alias."
returns:
description: "the CustomEntityAlias object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CustomEntityAlias.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.CustomEntityAlias.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "CustomEntityAlias.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: "A complex object that can be used to specify alternative spellings or synonyms to the root entity name."
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.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3