你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchIndexer 类

参考

表示索引器。

必须填充所有必需的参数才能发送到 Azure。

继承: azure.search.documents.indexes._generated._serialization.Model

SearchIndexer

构造函数

SearchIndexer(*, name: str, data_source_name: str, target_index_name: str, description: str | None = None, skillset_name: str | None = None, schedule: _models.IndexingSchedule | None = None, parameters: _models.IndexingParameters | None = None, field_mappings: List[_models.FieldMapping] | None = None, output_field_mappings: List[_models.FieldMapping] | None = None, is_disabled: bool = False, e_tag: str | None = None, encryption_key: _models.SearchResourceEncryptionKey | None = None, **kwargs: Any)

仅限关键字的参数

名称	说明
name	str 索引器的名称。必需。
description	str 索引器的说明。
data_source_name	str 此索引器从中读取数据的数据源的名称。必需。
skillset_name	str 使用此索引器执行的技能组的名称。
target_index_name	str 此索引器将数据写入到的索引的名称。必需。
schedule	<xref:search_service_client.models.IndexingSchedule> 此索引器的计划。
parameters	<xref:search_service_client.models.IndexingParameters> 索引器执行的参数。
field_mappings	list[<xref:search_service_client.models.FieldMapping>] 定义数据源中的字段与索引中相应目标字段之间的映射。
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] 输出字段映射在扩充后应用，在编制索引之前立即应用。
is_disabled	bool 一个值，该值指示是否禁用索引器。默认值为 false。
e_tag	str 索引器的 ETag。
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> 在 Azure 密钥保管库中创建的加密密钥的说明。此密钥用于为索引器定义 (提供额外的静态加密级别，以及索引器执行状态) （如果希望完全保证没有人（甚至 Microsoft）无法解密它们。加密索引器定义后，它将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果要轮换加密密钥，可以根据需要更改此属性;索引器定义 (和索引器执行状态) 将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

变量

名称	说明
name	str 索引器的名称。必需。
description	str 索引器的说明。
data_source_name	str 此索引器从中读取数据的数据源的名称。必需。
skillset_name	str 使用此索引器执行的技能组的名称。
target_index_name	str 此索引器将数据写入到的索引的名称。必需。
schedule	<xref:search_service_client.models.IndexingSchedule> 此索引器的计划。
parameters	<xref:search_service_client.models.IndexingParameters> 索引器执行的参数。
field_mappings	list[<xref:search_service_client.models.FieldMapping>] 定义数据源中的字段与索引中相应目标字段之间的映射。
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] 输出字段映射在扩充后应用，在编制索引之前立即应用。
is_disabled	bool 一个值，该值指示是否禁用索引器。默认值为 false。
e_tag	str 索引器的 ETag。
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> 在 Azure 密钥保管库中创建的加密密钥的说明。此密钥用于为索引器定义 (提供额外的静态加密级别，以及索引器执行状态) （如果希望完全保证没有人（甚至 Microsoft）无法解密它们。加密索引器定义后，它将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果要轮换加密密钥，可以根据需要更改此属性;索引器定义 (和索引器执行状态) 将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

方法

as_dict	返回可以使用 json.dump 序列化的 dict。高级用法可以选择使用回调作为参数： Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此对象中的当前值。返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果 dict。请参阅此文件中的三个示例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果需要 XML 序列化，可以传递 kwargs is_xml=True。
deserialize	使用 RestAPI 语法分析 str 并返回模型。
enable_additional_properties_sending
from_dict	使用给定的键提取程序分析 dict 会返回模型。默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	返回将从此模型发送到服务器的 JSON。这是 as_dict (full_restapi_key_transformer 的别名，keep_readonly=False) 。如果需要 XML 序列化，可以传递 kwargs is_xml=True。

as_dict

返回可以使用 json.dump 序列化的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此对象中的当前值。

返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果 dict。

请参阅此文件中的三个示例：

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

如果需要 XML 序列化，可以传递 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]

参数

名称	说明
key_transformer	<xref:function> 密钥转换器函数。
keep_readonly	默认值: True

类型	说明
dict	与 dict JSON 兼容的对象

deserialize

使用 RestAPI 语法分析 str 并返回模型。

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

参数

名称	说明
data 必需	str 使用 RestAPI 结构的 str。默认情况下为 JSON。
content_type	str 默认情况下，如果为 XML，则设置 application/xml。默认值: None

类型	说明
	此模型的实例

例外

类型	说明
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

使用给定的键提取程序分析 dict 会返回模型。

默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和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

参数

名称	说明
data 必需	dict 使用 RestAPI 结构的 dict
content_type	str 默认情况下，如果为 XML，则设置 application/xml。默认值: None
key_extractors	默认值: None

类型	说明
	此模型的实例

例外

类型	说明
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

返回将从此模型发送到服务器的 JSON。

这是 as_dict (full_restapi_key_transformer 的别名 ，keep_readonly=False) 。