Partager via

SearchIndexerIndexProjectionSelector Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.4
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexerIndexProjectionSelector

Implements

JsonSerializable<SearchIndexerIndexProjectionSelector>

public final class SearchIndexerIndexProjectionSelector
implements JsonSerializable<SearchIndexerIndexProjectionSelector>

Description for what data to store in the designated search index.

Constructor Summary

Constructor Description
SearchIndexerIndexProjectionSelector(String targetIndexName, String parentKeyFieldName, String sourceContext, List<InputFieldMappingEntry> mappings)

Creates an instance of SearchIndexerIndexProjectionSelector class.

Method Summary

Modifier and Type Method and Description
static SearchIndexerIndexProjectionSelector fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerIndexProjectionSelector from the JsonReader.
List<InputFieldMappingEntry> getMappings()

Get the mappings property: Mappings for the projection, or which source should be mapped to which field in the target index.
String getParentKeyFieldName()

Get the parentKeyFieldName property: Name of the field in the search index to map the parent document's key value to.
String getSourceContext()

Get the sourceContext property: Source context for the projections.
String getTargetIndexName()

Get the targetIndexName property: Name of the search index to project to.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexerIndexProjectionSelector

public SearchIndexerIndexProjectionSelector(String targetIndexName, String parentKeyFieldName, String sourceContext, List 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

fromJson

public static SearchIndexerIndexProjectionSelector fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getMappings

public List 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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to