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

Class WebApiSkill

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerSkill

com.azure.search.documents.indexes.models.WebApiSkill

public final class WebApiSkill
extends SearchIndexerSkill

A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Integer	getBatchSize()	Get the batchSize property: The desired batch size which indicates number of documents.
Integer	getDegreeOfParallelism()	Get the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API.
Map<String,String>	getHttpHeaders()	Get the httpHeaders property: The headers required to make the http request.
String	getHttpMethod()	Get the httpMethod property: The method for the http request.
Duration	getTimeout()	Get the timeout property: The desired timeout for the request.
String	getUri()	Get the uri property: The url for the Web API.
WebApiSkill	setBatchSize(Integer batchSize)	Set the batchSize property: The desired batch size which indicates number of documents.
WebApiSkill	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).
WebApiSkill	setDegreeOfParallelism(Integer degreeOfParallelism)	Set the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API.
WebApiSkill	setDescription(String description)	Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
WebApiSkill	setHttpHeaders(Map<String,String> httpHeaders)	Set the httpHeaders property: The headers required to make the http request.
WebApiSkill	setHttpMethod(String httpMethod)	Set the httpMethod property: The method for the http request.
WebApiSkill	setName(String name)	Set the name property: The name of the skill which uniquely identifies it within the skillset.
WebApiSkill	setTimeout(Duration timeout)	Set the timeout property: The desired timeout for the request.

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

WebApiSkill

public WebApiSkill(List<InputFieldMappingEntry> inputs,
 List<OutputFieldMappingEntry> outputs,
 String uri)

Creates an instance of WebApiSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

uri - the uri value to set.

Method Details

getUri

public String getUri()

Get the uri property: The url for the Web API.

Returns:

the uri value.

getHttpHeaders

public Map<String,String> getHttpHeaders()

Get the httpHeaders property: The headers required to make the http request.

Returns:

the httpHeaders value.

setHttpHeaders

public WebApiSkill setHttpHeaders(Map<String,String> httpHeaders)

Set the httpHeaders property: The headers required to make the http request.

Parameters:

httpHeaders - the httpHeaders value to set.

Returns:

the WebApiSkill object itself.

getHttpMethod

public String getHttpMethod()

Get the httpMethod property: The method for the http request.

Returns:

the httpMethod value.

setHttpMethod

public WebApiSkill setHttpMethod(String httpMethod)

Set the httpMethod property: The method for the http request.

Parameters:

httpMethod - the httpMethod value to set.

Returns:

the WebApiSkill object itself.

getTimeout

public Duration getTimeout()

Get the timeout property: The desired timeout for the request. Default is 30 seconds.

Returns:

the timeout value.

setTimeout

public WebApiSkill setTimeout(Duration timeout)

Set the timeout property: The desired timeout for the request. Default is 30 seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the WebApiSkill object itself.

getBatchSize

public Integer getBatchSize()

Get the batchSize property: The desired batch size which indicates number of documents.

Returns:

the batchSize value.

setBatchSize

public WebApiSkill setBatchSize(Integer batchSize)

Set the batchSize property: The desired batch size which indicates number of documents.

Parameters:

batchSize - the batchSize value to set.

Returns:

the WebApiSkill object itself.

getDegreeOfParallelism

public Integer getDegreeOfParallelism()

Get the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API.

Returns:

the degreeOfParallelism value.

setDegreeOfParallelism

public WebApiSkill setDegreeOfParallelism(Integer degreeOfParallelism)

Set the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API.

Parameters:

degreeOfParallelism - the degreeOfParallelism value to set.

Returns:

the WebApiSkill object itself.

setName

public WebApiSkill 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 WebApiSkill 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 WebApiSkill 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.