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
All Methods Instance Methods Concrete Methods 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
setDegreeOfParallelism(Integer degreeOfParallelism)
Set the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API.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
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, setContext, setDescription, setName
-
-
-
-
Constructor Detail
-
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 Detail
-
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.
-
-