SearchIndexer Klass
Representerar en indexerare.
Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
- Arv
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexer
Konstruktor
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)Keyword-Only parametrar
| Name | Description |
|---|---|
|
name
|
Namnet på indexeraren. Krävs. |
|
description
|
Beskrivningen av indexeraren. |
|
data_source_name
|
Namnet på den datakälla som indexeraren läser data från. Krävs. |
|
skillset_name
|
Namnet på kompetensuppsättningen som körs med den här indexeraren. |
|
target_index_name
|
Namnet på indexet som indexeraren skriver data till. Krävs. |
|
schedule
|
<xref:search_service_client.models.IndexingSchedule>
Schemat för den här indexeraren. |
|
parameters
|
<xref:search_service_client.models.IndexingParameters>
Parametrar för indexeringskörning. |
|
field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Definierar mappningar mellan fält i datakällan och motsvarande målfält i indexet. |
|
output_field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Mappningar av utdatafält tillämpas efter berikning och omedelbart före indexering. |
|
is_disabled
|
Ett värde som anger om indexeraren är inaktiverad. Standardvärdet är false. |
|
e_tag
|
Indexerarens ETag. |
|
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge en ytterligare nivå av kryptering i vila för indexerarens definition (samt indexerarens körningsstatus) när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat indexerarens definition förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Indexerarens definition (och indexerarens körningsstatus) påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare. |
Variabler
| Name | Description |
|---|---|
|
name
|
Namnet på indexeraren. Krävs. |
|
description
|
Beskrivningen av indexeraren. |
|
data_source_name
|
Namnet på den datakälla som indexeraren läser data från. Krävs. |
|
skillset_name
|
Namnet på kompetensuppsättningen som körs med den här indexeraren. |
|
target_index_name
|
Namnet på indexet som indexeraren skriver data till. Krävs. |
|
schedule
|
<xref:search_service_client.models.IndexingSchedule>
Schemat för den här indexeraren. |
|
parameters
|
<xref:search_service_client.models.IndexingParameters>
Parametrar för indexeringskörning. |
|
field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Definierar mappningar mellan fält i datakällan och motsvarande målfält i indexet. |
|
output_field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Mappningar av utdatafält tillämpas efter berikning och omedelbart före indexering. |
|
is_disabled
|
Ett värde som anger om indexeraren är inaktiverad. Standardvärdet är false. |
|
e_tag
|
Indexerarens ETag. |
|
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge en ytterligare nivå av kryptering i vila för indexerarens definition (samt indexerarens körningsstatus) när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat indexerarens definition förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Indexerarens definition (och indexerarens körningsstatus) påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare. |
Metoder
| as_dict |
Returnera en diktamen som kan serialiseras med json.dump. Avancerad användning kan också använda ett återanrop som parameter: Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet. Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt. Se de tre exemplen i den här filen:
Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True. |
| deserialize |
Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell. |
| enable_additional_properties_sending | |
| from_dict |
Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell. Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
Returnera den JSON som skulle skickas till servern från den här modellen. Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False). Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True. |
as_dict
Returnera en diktamen som kan serialiseras med json.dump.
Avancerad användning kan också använda ett återanrop som parameter:
Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.
Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.
Se de tre exemplen i den här filen:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Om du vill ha XML-serialisering kan du skicka 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]Parametrar
| Name | Description |
|---|---|
|
key_transformer
|
<xref:function>
En nyckeltransformatorfunktion. |
|
keep_readonly
|
standardvärde: True
|
Returer
| Typ | Description |
|---|---|
|
Ett dict JSON-kompatibelt objekt |
deserialize
Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.
deserialize(data: Any, content_type: str | None = None) -> ModelTypeParametrar
| Name | Description |
|---|---|
|
data
Obligatorisk
|
En str som använder RestAPI-struktur. JSON som standard. |
|
content_type
|
JSON som standard anger du application/xml om XML. standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
En instans av den här modellen |
Undantag
| Typ | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_dict
Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.
Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och 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) -> ModelTypeParametrar
| Name | Description |
|---|---|
|
data
Obligatorisk
|
En dikta med Hjälp av RestAPI-struktur |
|
content_type
|
JSON som standard anger du application/xml om XML. standardvärde: None
|
|
key_extractors
|
standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
En instans av den här modellen |
Undantag
| Typ | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
Returnera den JSON som skulle skickas till servern från den här modellen.
Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).
Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]Parametrar
| Name | Description |
|---|---|
|
keep_readonly
|
Om du vill serialisera readonly-attributen standardvärde: False
|
Returer
| Typ | Description |
|---|---|
|
Ett dict JSON-kompatibelt objekt |
Azure SDK for Python