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

189 строки
16 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.MergeSkill"
fullName: "com.azure.search.documents.indexes.models.MergeSkill"
name: "MergeSkill"
nameWithType: "MergeSkill"
summary: "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getName()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- 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 **MergeSkill**</br> extends <xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.documents.indexes.models.MergeSkill.MergeSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
name: "MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
nameWithType: "MergeSkill.MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
summary: "Creates an instance of Merge<wbr>Skill class."
parameters:
- description: "the inputs value to set."
name: "inputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "the outputs value to set."
name: "outputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
desc: "Creates an instance of MergeSkill class."
methods:
- uid: "com.azure.search.documents.indexes.models.MergeSkill.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "MergeSkill.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Merge<wbr>Skill 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 MergeSkill 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 MergeSkill from the JsonReader."
returns:
description: "An instance of MergeSkill if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.getInsertPostTag()"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.getInsertPostTag()"
name: "getInsertPostTag()"
nameWithType: "MergeSkill.getInsertPostTag()"
summary: "Get the insert<wbr>Post<wbr>Tag property: The tag indicates the end of the merged text."
syntax: "public String getInsertPostTag()"
desc: "Get the insertPostTag property: The tag indicates the end of the merged text. By default, the tag is an empty space."
returns:
description: "the insertPostTag 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.MergeSkill.getInsertPreTag()"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.getInsertPreTag()"
name: "getInsertPreTag()"
nameWithType: "MergeSkill.getInsertPreTag()"
summary: "Get the insert<wbr>Pre<wbr>Tag property: The tag indicates the start of the merged text."
syntax: "public String getInsertPreTag()"
desc: "Get the insertPreTag property: The tag indicates the start of the merged text. By default, the tag is an empty space."
returns:
description: "the insertPreTag 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.MergeSkill.getOdataType()"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.getOdataType()"
name: "getOdataType()"
nameWithType: "MergeSkill.getOdataType()"
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of skill."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()"
syntax: "public String getOdataType()"
desc: "Get the odataType property: A URI fragment specifying the type of skill."
returns:
description: "the odataType 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.MergeSkill.setContext(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.setContext(String context)"
name: "setContext(String context)"
nameWithType: "MergeSkill.setContext(String context)"
summary: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)"
parameters:
- name: "context"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MergeSkill setContext(String context)"
desc: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.setDescription(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "MergeSkill.setDescription(String description)"
summary: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)"
parameters:
- name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MergeSkill setDescription(String description)"
desc: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.setInsertPostTag(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.setInsertPostTag(String insertPostTag)"
name: "setInsertPostTag(String insertPostTag)"
nameWithType: "MergeSkill.setInsertPostTag(String insertPostTag)"
summary: "Set the insert<wbr>Post<wbr>Tag property: The tag indicates the end of the merged text."
parameters:
- description: "the insertPostTag value to set."
name: "insertPostTag"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MergeSkill setInsertPostTag(String insertPostTag)"
desc: "Set the insertPostTag property: The tag indicates the end of the merged text. By default, the tag is an empty space."
returns:
description: "the MergeSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.setInsertPreTag(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.setInsertPreTag(String insertPreTag)"
name: "setInsertPreTag(String insertPreTag)"
nameWithType: "MergeSkill.setInsertPreTag(String insertPreTag)"
summary: "Set the insert<wbr>Pre<wbr>Tag property: The tag indicates the start of the merged text."
parameters:
- description: "the insertPreTag value to set."
name: "insertPreTag"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MergeSkill setInsertPreTag(String insertPreTag)"
desc: "Set the insertPreTag property: The tag indicates the start of the merged text. By default, the tag is an empty space."
returns:
description: "the MergeSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.setName(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.setName(String name)"
name: "setName(String name)"
nameWithType: "MergeSkill.setName(String name)"
summary: "Set the name property: The name of the skill which uniquely identifies it within the skillset."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)"
parameters:
- name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MergeSkill setName(String name)"
desc: "Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '\\#'."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.MergeSkill?alt=com.azure.search.documents.indexes.models.MergeSkill&text=MergeSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.MergeSkill.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.MergeSkill.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "MergeSkill.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.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 skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part."
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.1