SearchIndexerIndexProjectionSelector Class

  • Reference

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

All required parameters must be populated in order to send to server.

Inheritance
azure.search.documents.indexes._generated._serialization.Model
SearchIndexerIndexProjectionSelector

Constructor

SearchIndexerIndexProjectionSelector(*, target_index_name: str, parent_key_field_name: str, source_context: str, mappings: List[_models.InputFieldMappingEntry], **kwargs: Any)

Keyword-Only Parameters

Name Description
target_index_name
str

Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. Required.
parent_key_field_name
str

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. Required.
source_context
str

Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. Required.
mappings
list[InputFieldMappingEntry]

Mappings for the projection, or which source should be mapped to which field in the target index. Required.

Variables

Name Description
target_index_name
str

Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. Required.
parent_key_field_name
str

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. Required.
source_context
str

Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. Required.
mappings
list[InputFieldMappingEntry]

Mappings for the projection, or which source should be mapped to which field in the target index. Required.

Methods

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize

Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name Description
key_transformer
<xref:function>

A key transformer function.
keep_readonly
Default value: True

Returns

Type Description
dict

A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name Description
data
Required
str

A str using RestAPI structure. JSON by default.
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description

An instance of this model

Exceptions

Type Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameters

Name Description
data
Required
dict

A dict using RestAPI structure
content_type
str

JSON by default, set application/xml if XML.

Default value: None
key_extractors
Default value: None

Returns

Type Description

An instance of this model

Exceptions

Type Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: False

Returns

Type Description
dict

A dict JSON compatible object