Package com.azure.search.documents.indexes.models

Class SearchIndexerIndexProjectionSelector

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerIndexProjectionSelector
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerIndexProjectionSelector>
public final class SearchIndexerIndexProjectionSelector extends Object implements com.azure.json.JsonSerializable<SearchIndexerIndexProjectionSelector>
Description for what data to store in the designated search index.

  • Constructor Details

    • SearchIndexerIndexProjectionSelector

      public SearchIndexerIndexProjectionSelector(String targetIndexName, String parentKeyFieldName, String sourceContext, List<InputFieldMappingEntry> mappings)
      Creates an instance of SearchIndexerIndexProjectionSelector class.
      Parameters:
      targetIndexName - the targetIndexName value to set.
      parentKeyFieldName - the parentKeyFieldName value to set.
      sourceContext - the sourceContext value to set.
      mappings - the mappings value to set.

  • Method Details

    • getTargetIndexName

      public String getTargetIndexName()
      Get the targetIndexName property: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set.
      Returns:
      the targetIndexName value.

    • getParentKeyFieldName

      public String getParentKeyFieldName()
      Get the parentKeyFieldName property: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field.
      Returns:
      the parentKeyFieldName value.

    • getSourceContext

      public String getSourceContext()
      Get the sourceContext property: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents.
      Returns:
      the sourceContext value.

    • getMappings

      public List<InputFieldMappingEntry> getMappings()
      Get the mappings property: Mappings for the projection, or which source should be mapped to which field in the target index.
      Returns:
      the mappings value.

    • toJson

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

    • fromJson

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