Class SearchIndexKnowledgeSourceParameters

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexKnowledgeSourceParameters>
public final class SearchIndexKnowledgeSourceParameters extends Object implements com.azure.json.JsonSerializable<SearchIndexKnowledgeSourceParameters>
Parameters for search index knowledge source.

  • Constructor Details

    • SearchIndexKnowledgeSourceParameters

      public SearchIndexKnowledgeSourceParameters(String searchIndexName)
      Creates an instance of SearchIndexKnowledgeSourceParameters class.
      Parameters:
      searchIndexName - the searchIndexName value to set.

  • Method Details

    • getSearchIndexName

      public String getSearchIndexName()
      Get the searchIndexName property: The name of the Search index.
      Returns:
      the searchIndexName value.

    • getSourceDataFields

      public List<SearchIndexFieldReference> getSourceDataFields()
      Get the sourceDataFields property: Used to request additional fields for referenced source data.
      Returns:
      the sourceDataFields value.

    • setSourceDataFields

      public SearchIndexKnowledgeSourceParameters setSourceDataFields(List<SearchIndexFieldReference> sourceDataFields)
      Set the sourceDataFields property: Used to request additional fields for referenced source data.
      Parameters:
      sourceDataFields - the sourceDataFields value to set.
      Returns:
      the SearchIndexKnowledgeSourceParameters object itself.

    • getSearchFields

      public List<SearchIndexFieldReference> getSearchFields()
      Get the searchFields property: Used to restrict which fields to search on the search index.
      Returns:
      the searchFields value.

    • setSearchFields

      public SearchIndexKnowledgeSourceParameters setSearchFields(List<SearchIndexFieldReference> searchFields)
      Set the searchFields property: Used to restrict which fields to search on the search index.
      Parameters:
      searchFields - the searchFields value to set.
      Returns:
      the SearchIndexKnowledgeSourceParameters object itself.

    • getSemanticConfigurationName

      public String getSemanticConfigurationName()
      Get the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.
      Returns:
      the semanticConfigurationName value.

    • setSemanticConfigurationName

      public SearchIndexKnowledgeSourceParameters setSemanticConfigurationName(String semanticConfigurationName)
      Set the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.
      Parameters:
      semanticConfigurationName - the semanticConfigurationName value to set.
      Returns:
      the SearchIndexKnowledgeSourceParameters 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<SearchIndexKnowledgeSourceParameters>
      Throws:
      IOException

    • fromJson

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