Class KnowledgeBaseSearchIndexActivityArguments

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

  • Constructor Details

    • KnowledgeBaseSearchIndexActivityArguments

      public KnowledgeBaseSearchIndexActivityArguments()
      Creates an instance of KnowledgeBaseSearchIndexActivityArguments class.

  • Method Details

    • getSearch

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

    • setSearch

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

    • getFilter

      public String getFilter()
      Get the filter property: The filter string.
      Returns:
      the filter value.

    • setFilter

      public KnowledgeBaseSearchIndexActivityArguments setFilter(String filter)
      Set the filter property: The filter string.
      Parameters:
      filter - the filter value to set.
      Returns:
      the KnowledgeBaseSearchIndexActivityArguments object itself.

    • getSourceDataFields

      public List<SearchIndexFieldReference> getSourceDataFields()
      Get the sourceDataFields property: What fields were selected for search.
      Returns:
      the sourceDataFields value.

    • setSourceDataFields

      public KnowledgeBaseSearchIndexActivityArguments setSourceDataFields(List<SearchIndexFieldReference> sourceDataFields)
      Set the sourceDataFields property: What fields were selected for search.
      Parameters:
      sourceDataFields - the sourceDataFields value to set.
      Returns:
      the KnowledgeBaseSearchIndexActivityArguments object itself.

    • getSearchFields

      public List<SearchIndexFieldReference> getSearchFields()
      Get the searchFields property: What fields were searched against.
      Returns:
      the searchFields value.

    • setSearchFields

      public KnowledgeBaseSearchIndexActivityArguments setSearchFields(List<SearchIndexFieldReference> searchFields)
      Set the searchFields property: What fields were searched against.
      Parameters:
      searchFields - the searchFields value to set.
      Returns:
      the KnowledgeBaseSearchIndexActivityArguments object itself.

    • getSemanticConfigurationName

      public String getSemanticConfigurationName()
      Get the semanticConfigurationName property: What semantic configuration was used from the search index.
      Returns:
      the semanticConfigurationName value.

    • setSemanticConfigurationName

      public KnowledgeBaseSearchIndexActivityArguments setSemanticConfigurationName(String semanticConfigurationName)
      Set the semanticConfigurationName property: What semantic configuration was used from the search index.
      Parameters:
      semanticConfigurationName - the semanticConfigurationName value to set.
      Returns:
      the KnowledgeBaseSearchIndexActivityArguments 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<KnowledgeBaseSearchIndexActivityArguments>
      Throws:
      IOException

    • fromJson

      public static KnowledgeBaseSearchIndexActivityArguments fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KnowledgeBaseSearchIndexActivityArguments from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KnowledgeBaseSearchIndexActivityArguments 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 KnowledgeBaseSearchIndexActivityArguments.