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

public final class ShaperSkill
extends SearchIndexerSkill

A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields).

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static ShaperSkill	fromJson(JsonReader jsonReader) Reads an instance of ShaperSkill from the JsonReader.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
ShaperSkill	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).
ShaperSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
ShaperSkill	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

ShaperSkill

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

Creates an instance of ShaperSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static ShaperSkill fromJson(JsonReader jsonReader)

Reads an instance of ShaperSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getOdataType

public String getOdataType()

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

Overrides:

ShaperSkill.getOdataType()

Returns:

the odataType value.

setContext

public ShaperSkill 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:

ShaperSkill.setContext(String context)

Parameters:

context

setDescription

public ShaperSkill setDescription(String description)

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

Overrides:

ShaperSkill.setDescription(String description)

Parameters:

description

setName

public ShaperSkill 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:

ShaperSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ShaperSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException