Package com.azure.search.documents.indexes.models

Class ShaperSkill

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

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class com.azure.search.documents.indexes.models.SearchIndexerSkill

getContext, getDescription, getInputs, getName, getOutputs

Methods inherited from class 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

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:

setName in class SearchIndexerSkill

Parameters:

name - the name value to set.

Returns:

the SearchIndexerSkill object itself.

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:

setDescription in class SearchIndexerSkill

Parameters:

description - the description value to set.

Returns:

the SearchIndexerSkill object itself.

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:

setContext in class SearchIndexerSkill

Parameters:

context - the context value to set.

Returns:

the SearchIndexerSkill object itself.