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
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
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 Details

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of skill.
      Overrides:
      getOdataType in class SearchIndexerSkill
      Returns:
      the odataType value.

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

    • getAuthResourceId

      public String getAuthResourceId()
      Get the authResourceId property: Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.
      Returns:
      the authResourceId value.

    • setAuthResourceId

      public WebApiSkill setAuthResourceId(String authResourceId)
      Set the authResourceId property: Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.
      Parameters:
      authResourceId - the authResourceId value to set.
      Returns:
      the WebApiSkill object itself.

    • getAuthIdentity

      public SearchIndexerDataIdentity getAuthIdentity()
      Get the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
      Returns:
      the authIdentity value.

    • setAuthIdentity

      public WebApiSkill setAuthIdentity(SearchIndexerDataIdentity authIdentity)
      Set the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
      Parameters:
      authIdentity - the authIdentity 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SearchIndexerSkill>
      Overrides:
      toJson in class SearchIndexerSkill
      Throws:
      IOException

    • fromJson

      public static WebApiSkill fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of WebApiSkill from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of WebApiSkill if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the WebApiSkill.