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

public final class ConditionalSkill
extends SearchIndexerSkill

A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.

Constructor Summary

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

Method Summary

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

ConditionalSkill

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

Creates an instance of ConditionalSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static ConditionalSkill fromJson(JsonReader jsonReader)

Reads an instance of ConditionalSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ConditionalSkill 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:

ConditionalSkill.getOdataType()

Returns:

the odataType value.

setContext

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

ConditionalSkill.setContext(String context)

Parameters:

context

setDescription

public ConditionalSkill setDescription(String description)

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

Overrides:

ConditionalSkill.setDescription(String description)

Parameters:

description

setName

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

ConditionalSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ConditionalSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException