Class KnowledgeBaseWebActivityArguments

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityArguments
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseWebActivityArguments>
public final class KnowledgeBaseWebActivityArguments extends Object implements com.azure.json.JsonSerializable<KnowledgeBaseWebActivityArguments>
Represents the arguments the web retrieval activity was run with.

  • Constructor Details

    • KnowledgeBaseWebActivityArguments

      public KnowledgeBaseWebActivityArguments()
      Creates an instance of KnowledgeBaseWebActivityArguments class.

  • Method Details

    • getSearch

      public String getSearch()
      Get the search property: The search string used to query the web.
      Returns:
      the search value.

    • setSearch

      public KnowledgeBaseWebActivityArguments setSearch(String search)
      Set the search property: The search string used to query the web.
      Parameters:
      search - the search value to set.
      Returns:
      the KnowledgeBaseWebActivityArguments object itself.

    • getLanguage

      public String getLanguage()
      Get the language property: The language for the retrieval activity.
      Returns:
      the language value.

    • setLanguage

      public KnowledgeBaseWebActivityArguments setLanguage(String language)
      Set the language property: The language for the retrieval activity.
      Parameters:
      language - the language value to set.
      Returns:
      the KnowledgeBaseWebActivityArguments object itself.

    • getMarket

      public String getMarket()
      Get the market property: The market for the retrieval activity.
      Returns:
      the market value.

    • setMarket

      public KnowledgeBaseWebActivityArguments setMarket(String market)
      Set the market property: The market for the retrieval activity.
      Parameters:
      market - the market value to set.
      Returns:
      the KnowledgeBaseWebActivityArguments object itself.

    • getCount

      public Integer getCount()
      Get the count property: The number of web results returned.
      Returns:
      the count value.

    • setCount

      public KnowledgeBaseWebActivityArguments setCount(Integer count)
      Set the count property: The number of web results returned.
      Parameters:
      count - the count value to set.
      Returns:
      the KnowledgeBaseWebActivityArguments object itself.

    • getFreshness

      public String getFreshness()
      Get the freshness property: The freshness for the retrieval activity.
      Returns:
      the freshness value.

    • setFreshness

      public KnowledgeBaseWebActivityArguments setFreshness(String freshness)
      Set the freshness property: The freshness for the retrieval activity.
      Parameters:
      freshness - the freshness value to set.
      Returns:
      the KnowledgeBaseWebActivityArguments 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<KnowledgeBaseWebActivityArguments>
      Throws:
      IOException

    • fromJson

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