SearchIndexer 類別
表示索引子。
必須填入所有必要的參數，才能傳送至 Azure。
- 繼承
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexer
建構函式
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)僅限關鍵字參數
| 名稱 | Description |
|---|---|
|
name
|
索引子的名稱。 必要。 |
|
description
|
索引子的描述。 |
|
data_source_name
|
這個索引子從中讀取資料的資料來源名稱。 必要。 |
|
skillset_name
|
使用此索引子執行的技能集名稱。 |
|
target_index_name
|
這個索引子寫入資料的索引名稱。 必要。 |
|
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
|
值，指出索引子是否已停用。 預設值為 false。 |
|
e_tag
|
索引子的 ETag。 |
|
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
您在 Azure 金鑰保存庫中建立的加密金鑰描述。 此金鑰可用來為索引子定義提供額外的待用加密層級 (，以及當您想要完全保證沒有任何人甚至 Microsoft 無法解密時，索引子執行狀態) 。 加密索引子定義之後，它一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 Null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的索引子定義 (和索引子執行狀態) 將不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用于在 2019 年 1 月 1 日或之後建立的付費服務。 |
變數
| 名稱 | Description |
|---|---|
|
name
|
索引子的名稱。 必要。 |
|
description
|
索引子的描述。 |
|
data_source_name
|
這個索引子從中讀取資料的資料來源名稱。 必要。 |
|
skillset_name
|
使用此索引子執行的技能集名稱。 |
|
target_index_name
|
這個索引子寫入資料的索引名稱。 必要。 |
|
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
|
值，指出索引子是否已停用。 預設值為 false。 |
|
e_tag
|
索引子的 ETag。 |
|
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
您在 Azure 金鑰保存庫中建立的加密金鑰描述。 此金鑰可用來為索引子定義提供額外的待用加密層級 (，以及當您想要完全保證沒有任何人甚至 Microsoft 無法解密時，索引子執行狀態) 。 加密索引子定義之後，它一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 Null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的索引子定義 (和索引子執行狀態) 將不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用于在 2019 年 1 月 1 日或之後建立的付費服務。 |
方法
| as_dict |
傳回可使用 json.dump 序列化的聽寫。 進階用法可以選擇性地使用回呼作為參數： 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例：
如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。 |
| deserialize |
使用 RestAPI 語法剖析 str 並傳回模型。 |
| enable_additional_properties_sending | |
| from_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 序列化的聽寫。
進階用法可以選擇性地使用回呼作為參數：
索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例：
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]參數
| 名稱 | Description |
|---|---|
|
key_transformer
|
<xref:function>
按鍵轉換程式函式。 |
|
keep_readonly
|
預設值: True
|
傳回
| 類型 | Description |
|---|---|
|
聽寫 JSON 相容物件 |
deserialize
使用 RestAPI 語法剖析 str 並傳回模型。
deserialize(data: Any, content_type: str | None = None) -> ModelType參數
| 名稱 | Description |
|---|---|
|
data
必要
|
使用 RestAPI 結構的 str。 根據預設，JSON。 |
|
content_type
|
根據預設，如果 XML，請設定 application/xml。 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
此模型的實例 |
例外狀況
| 類型 | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_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參數
| 名稱 | Description |
|---|---|
|
data
必要
|
使用 RestAPI 結構的聽寫 |
|
content_type
|
根據預設，如果 XML，請設定 application/xml。 預設值: None
|
|
key_extractors
|
預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
此模型的實例 |
例外狀況
| 類型 | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
傳回會從此模型傳送至伺服器的 JSON。
這是as_dict (full_restapi_key_transformer的別名 ，keep_readonly=False) 。
如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]參數
| 名稱 | Description |
|---|---|
|
keep_readonly
|
如果您想要序列化唯讀屬性 預設值: False
|
傳回
| 類型 | Description |
|---|---|
|
聽寫 JSON 相容物件 |
