193 строки
14 KiB
YAML
193 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.models.WebApiSkill"
|
|
fullName: "com.azure.search.models.WebApiSkill"
|
|
name: "WebApiSkill"
|
|
nameWithType: "WebApiSkill"
|
|
summary: "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.models.Skill?alt=com.azure.search.models.Skill&text=Skill\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.models.Skill.getContext()?alt=com.azure.search.models.Skill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.getDescription()?alt=com.azure.search.models.Skill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.getInputs()?alt=com.azure.search.models.Skill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.getName()?alt=com.azure.search.models.Skill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.getOutputs()?alt=com.azure.search.models.Skill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.setContext(java.lang.String)?alt=com.azure.search.models.Skill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.setDescription(java.lang.String)?alt=com.azure.search.models.Skill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.setInputs(java.util.List<com.azure.search.models.InputFieldMappingEntry>)?alt=com.azure.search.models.Skill.setInputs&text=setInputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.setName(java.lang.String)?alt=com.azure.search.models.Skill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.models.Skill.setOutputs(java.util.List<com.azure.search.models.OutputFieldMappingEntry>)?alt=com.azure.search.models.Skill.setOutputs&text=setOutputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **WebApiSkill**</br> extends <xref href=\"com.azure.search.models.Skill?alt=com.azure.search.models.Skill&text=Skill\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.models.WebApiSkill.WebApiSkill()"
|
|
fullName: "com.azure.search.models.WebApiSkill.WebApiSkill()"
|
|
name: "WebApiSkill()"
|
|
nameWithType: "WebApiSkill.WebApiSkill()"
|
|
syntax: "public WebApiSkill()"
|
|
methods:
|
|
- uid: "com.azure.search.models.WebApiSkill.getBatchSize()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getBatchSize()"
|
|
name: "getBatchSize()"
|
|
nameWithType: "WebApiSkill.getBatchSize()"
|
|
summary: "Get the batch<wbr>Size property: The desired batch size which indicates number of documents."
|
|
syntax: "public Integer getBatchSize()"
|
|
desc: "Get the batchSize property: The desired batch size which indicates number of documents."
|
|
returns:
|
|
description: "the batchSize value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.models.WebApiSkill.getDegreeOfParallelism()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getDegreeOfParallelism()"
|
|
name: "getDegreeOfParallelism()"
|
|
nameWithType: "WebApiSkill.getDegreeOfParallelism()"
|
|
summary: "Get the degree<wbr>OfParallelism property: If set, the number of parallel calls that can be made to the Web API."
|
|
syntax: "public Integer getDegreeOfParallelism()"
|
|
desc: "Get the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API."
|
|
returns:
|
|
description: "the degreeOfParallelism value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.models.WebApiSkill.getHttpHeaders()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getHttpHeaders()"
|
|
name: "getHttpHeaders()"
|
|
nameWithType: "WebApiSkill.getHttpHeaders()"
|
|
summary: "Get the http<wbr>Headers property: The headers required to make the http request."
|
|
syntax: "public Map<String,String> getHttpHeaders()"
|
|
desc: "Get the httpHeaders property: The headers required to make the http request."
|
|
returns:
|
|
description: "the httpHeaders value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.search.models.WebApiSkill.getHttpMethod()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getHttpMethod()"
|
|
name: "getHttpMethod()"
|
|
nameWithType: "WebApiSkill.getHttpMethod()"
|
|
summary: "Get the http<wbr>Method property: The method for the http request."
|
|
syntax: "public String getHttpMethod()"
|
|
desc: "Get the httpMethod property: The method for the http request."
|
|
returns:
|
|
description: "the httpMethod value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.models.WebApiSkill.getTimeout()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getTimeout()"
|
|
name: "getTimeout()"
|
|
nameWithType: "WebApiSkill.getTimeout()"
|
|
summary: "Get the timeout property: The desired timeout for the request."
|
|
syntax: "public Duration getTimeout()"
|
|
desc: "Get the timeout property: The desired timeout for the request. Default is 30 seconds."
|
|
returns:
|
|
description: "the timeout value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.search.models.WebApiSkill.getUri()"
|
|
fullName: "com.azure.search.models.WebApiSkill.getUri()"
|
|
name: "getUri()"
|
|
nameWithType: "WebApiSkill.getUri()"
|
|
summary: "Get the uri property: The url for the Web API."
|
|
syntax: "public String getUri()"
|
|
desc: "Get the uri property: The url for the Web API."
|
|
returns:
|
|
description: "the uri value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.models.WebApiSkill.setBatchSize(java.lang.Integer)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setBatchSize(Integer batchSize)"
|
|
name: "setBatchSize(Integer batchSize)"
|
|
nameWithType: "WebApiSkill.setBatchSize(Integer batchSize)"
|
|
summary: "Set the batch<wbr>Size property: The desired batch size which indicates number of documents."
|
|
parameters:
|
|
- description: "the batchSize value to set."
|
|
name: "batchSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public WebApiSkill setBatchSize(Integer batchSize)"
|
|
desc: "Set the batchSize property: The desired batch size which indicates number of documents."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.WebApiSkill.setDegreeOfParallelism(java.lang.Integer)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setDegreeOfParallelism(Integer degreeOfParallelism)"
|
|
name: "setDegreeOfParallelism(Integer degreeOfParallelism)"
|
|
nameWithType: "WebApiSkill.setDegreeOfParallelism(Integer degreeOfParallelism)"
|
|
summary: "Set the degree<wbr>OfParallelism property: If set, the number of parallel calls that can be made to the Web API."
|
|
parameters:
|
|
- description: "the degreeOfParallelism value to set."
|
|
name: "degreeOfParallelism"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public WebApiSkill setDegreeOfParallelism(Integer degreeOfParallelism)"
|
|
desc: "Set the degreeOfParallelism property: If set, the number of parallel calls that can be made to the Web API."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.WebApiSkill.setHttpHeaders(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setHttpHeaders(Map<String,String> httpHeaders)"
|
|
name: "setHttpHeaders(Map<String,String> httpHeaders)"
|
|
nameWithType: "WebApiSkill.setHttpHeaders(Map<String,String> httpHeaders)"
|
|
summary: "Set the http<wbr>Headers property: The headers required to make the http request."
|
|
parameters:
|
|
- description: "the httpHeaders value to set."
|
|
name: "httpHeaders"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public WebApiSkill setHttpHeaders(Map<String,String> httpHeaders)"
|
|
desc: "Set the httpHeaders property: The headers required to make the http request."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.WebApiSkill.setHttpMethod(java.lang.String)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setHttpMethod(String httpMethod)"
|
|
name: "setHttpMethod(String httpMethod)"
|
|
nameWithType: "WebApiSkill.setHttpMethod(String httpMethod)"
|
|
summary: "Set the http<wbr>Method property: The method for the http request."
|
|
parameters:
|
|
- description: "the httpMethod value to set."
|
|
name: "httpMethod"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public WebApiSkill setHttpMethod(String httpMethod)"
|
|
desc: "Set the httpMethod property: The method for the http request."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.WebApiSkill.setTimeout(java.time.Duration)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setTimeout(Duration timeout)"
|
|
name: "setTimeout(Duration timeout)"
|
|
nameWithType: "WebApiSkill.setTimeout(Duration timeout)"
|
|
summary: "Set the timeout property: The desired timeout for the request."
|
|
parameters:
|
|
- description: "the timeout value to set."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public WebApiSkill setTimeout(Duration timeout)"
|
|
desc: "Set the timeout property: The desired timeout for the request. Default is 30 seconds."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.WebApiSkill.setUri(java.lang.String)"
|
|
fullName: "com.azure.search.models.WebApiSkill.setUri(String uri)"
|
|
name: "setUri(String uri)"
|
|
nameWithType: "WebApiSkill.setUri(String uri)"
|
|
summary: "Set the uri property: The url for the Web API."
|
|
parameters:
|
|
- description: "the uri value to set."
|
|
name: "uri"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public WebApiSkill setUri(String uri)"
|
|
desc: "Set the uri property: The url for the Web API."
|
|
returns:
|
|
description: "the WebApiSkill object itself."
|
|
type: "<xref href=\"com.azure.search.models.WebApiSkill?alt=com.azure.search.models.WebApiSkill&text=WebApiSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code."
|
|
metadata: {}
|
|
package: "com.azure.search.models"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|