MergeSkill Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.SearchIndexerSkill
  • • com.azure.search.documents.indexes.models.MergeSkill

public final class MergeSkill
extends SearchIndexerSkill

A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.

Constructor Summary

Constructor	Description
MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of MergeSkill class.

Method Summary

Modifier and Type	Method and Description
static MergeSkill	fromJson(JsonReader jsonReader) Reads an instance of MergeSkill from the JsonReader.
String	getInsertPostTag() Get the insertPostTag property: The tag indicates the end of the merged text.
String	getInsertPreTag() Get the insertPreTag property: The tag indicates the start of the merged text.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
MergeSkill	setContext(String context) 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).
MergeSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
MergeSkill	setInsertPostTag(String insertPostTag) Set the insertPostTag property: The tag indicates the end of the merged text.
MergeSkill	setInsertPreTag(String insertPreTag) Set the insertPreTag property: The tag indicates the start of the merged text.
MergeSkill	setName(String name) Set the name property: The name of the skill which uniquely identifies it within the skillset.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from SearchIndexerSkill

fromJson getContext getDescription getInputs getName getOdataType getOutputs setContext setDescription setName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MergeSkill

public MergeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of MergeSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static MergeSkill fromJson(JsonReader jsonReader)

Reads an instance of MergeSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MergeSkill 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.

getInsertPostTag

public String getInsertPostTag()

Get the insertPostTag property: The tag indicates the end of the merged text. By default, the tag is an empty space.

Returns:

the insertPostTag value.

getInsertPreTag

public String getInsertPreTag()

Get the insertPreTag property: The tag indicates the start of the merged text. By default, the tag is an empty space.

Returns:

the insertPreTag value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

MergeSkill.getOdataType()

Returns:

the odataType value.

setContext

public MergeSkill setContext(String context)

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.

Overrides:

MergeSkill.setContext(String context)

Parameters:

context

setDescription

public MergeSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.

Overrides:

MergeSkill.setDescription(String description)

Parameters:

description

setInsertPostTag

public MergeSkill setInsertPostTag(String insertPostTag)

Set the insertPostTag property: The tag indicates the end of the merged text. By default, the tag is an empty space.

Parameters:

insertPostTag - the insertPostTag value to set.

Returns:

the MergeSkill object itself.

setInsertPreTag

public MergeSkill setInsertPreTag(String insertPreTag)

Set the insertPreTag property: The tag indicates the start of the merged text. By default, the tag is an empty space.

Parameters:

insertPreTag - the insertPreTag value to set.

Returns:

the MergeSkill object itself.

setName

public MergeSkill setName(String name)

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 '#'.

Overrides:

MergeSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MergeSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException