SearchIndexerDataSourceConnection Класс
Представляет определение подключения к источнику данных, которое можно использовать для настройки индексатора.
Для отправки в Azure необходимо заполнить все необходимые параметры.
- Наследование
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexerDataSourceConnection
Конструктор
SearchIndexerDataSourceConnection(**kwargs)
Переменные
Имя | Описание |
---|---|
name
|
Обязательный. Имя подключения к источнику данных. |
description
|
Описание подключения к источнику данных. |
type
|
Обязательный. Тип подключения к источнику данных. Возможные значения: "azuresql", "cosmosdb", "azureblob", "azuretable", "mysql", "adlsgen2". |
connection_string
|
Строка подключения для подключения к источнику данных. |
container
|
Обязательный. Контейнер данных для подключения к источнику данных. |
data_change_detection_policy
|
<xref:azure.search.documents.models.DataChangeDetectionPolicy>
Политика обнаружения изменений данных для подключения к источнику данных. |
data_deletion_detection_policy
|
<xref:azure.search.documents.models.DataDeletionDetectionPolicy>
Политика обнаружения удаления данных для подключения к источнику данных. |
e_tag
|
ETag источника данных. |
encryption_key
|
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования неактивных данных для определения источника данных, если требуется полная уверенность в том, что никто, даже корпорация Майкрософт, не может расшифровать определение источника данных в Когнитивный поиск Azure. После шифрования определения источника данных оно всегда останется зашифрованным. Когнитивный поиск Azure игнорирует попытки присвоить этому свойству значение NULL. Это свойство можно изменить при необходимости, если вы хотите сменить ключ шифрования. Определение источника данных не будет затронуто. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 года или позже. |
Методы
as_dict |
Возвращает дикт, который можно сериализовать с помощью json.dump. Дополнительное использование может использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле:
Если требуется xml-сериализация, можно передать kwargs is_xml=True. |
deserialize |
Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели. |
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 и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.
Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.
См. три примера в этом файле:
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
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект, совместимый с JSON для дикта |
deserialize
Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Параметры
Имя | Описание |
---|---|
data
Обязательно
|
Строка, использующий структуру RestAPI. JSON по умолчанию. |
content_type
|
JSON по умолчанию задайте значение application/xml if XML. значение по умолчанию: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Экземпляр этой модели |
Исключения
Тип | Описание |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_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
Обязательно
|
Словарь, использующий структуру RestAPI |
content_type
|
JSON по умолчанию задайте значение application/xml if 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).
Если требуется xml-сериализация, можно передать kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Параметры
Имя | Описание |
---|---|
keep_readonly
|
Если вы хотите сериализовать атрибуты только для чтения значение по умолчанию: False
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект, совместимый с JSON для дикта |
Azure SDK for Python