SearchIndexerDataContainer Kelas
Mewakili informasi tentang entitas (seperti tabel Azure SQL atau koleksi CosmosDB) yang akan diindeks.
Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.
- Warisan
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexerDataContainer
Konstruktor
SearchIndexerDataContainer(*, name: str, query: str | None = None, **kwargs: Any)
Parameter Kata Kunci-Saja
Nama | Deskripsi |
---|---|
name
|
Nama tabel atau tampilan (untuk sumber data Azure SQL) atau koleksi (untuk sumber data CosmosDB) yang akan diindeks. Wajib diisi. |
query
|
Kueri yang diterapkan ke kontainer data ini. Sintaksis dan arti parameter ini khusus sumber data. Tidak didukung oleh sumber data Azure SQL. |
Variabel
Nama | Deskripsi |
---|---|
name
|
Nama tabel atau tampilan (untuk sumber data Azure SQL) atau koleksi (untuk sumber data CosmosDB) yang akan diindeks. Wajib diisi. |
query
|
Kueri yang diterapkan ke kontainer data ini. Sintaksis dan arti parameter ini khusus sumber data. Tidak didukung oleh sumber data Azure SQL. |
Metode
as_dict |
Mengembalikan dict yang dapat diserialisasikan menggunakan json.dump. Penggunaan tingkat lanjut mungkin secara opsional menggunakan panggilan balik sebagai parameter: Kunci adalah nama atribut yang digunakan dalam Python. Attr_desc adalah dict metadata. Saat ini berisi 'type' dengan jenis msrest dan 'key' dengan kunci yang dikodekan RestAPI. Nilai adalah nilai saat ini dalam objek ini. String yang dikembalikan akan digunakan untuk menserialisasikan kunci. Jika jenis pengembalian adalah daftar, ini dianggap sebagai dict hasil hierarkis. Lihat tiga contoh dalam file ini:
Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True. |
deserialize |
Uraikan str menggunakan sintaks RestAPI dan kembalikan model. |
enable_additional_properties_sending | |
from_dict |
Mengurai dict menggunakan ekstraktor kunci yang diberikan mengembalikan model. Secara default, pertimbangkan ekstraktor kunci (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor, dan last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Mengembalikan JSON yang akan dikirim ke server dari model ini. Ini adalah alias untuk as_dict(full_restapi_key_transformer, keep_readonly=False). Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True. |
as_dict
Mengembalikan dict yang dapat diserialisasikan menggunakan json.dump.
Penggunaan tingkat lanjut mungkin secara opsional menggunakan panggilan balik sebagai parameter:
Kunci adalah nama atribut yang digunakan dalam Python. Attr_desc adalah dict metadata. Saat ini berisi 'type' dengan jenis msrest dan 'key' dengan kunci yang dikodekan RestAPI. Nilai adalah nilai saat ini dalam objek ini.
String yang dikembalikan akan digunakan untuk menserialisasikan kunci. Jika jenis pengembalian adalah daftar, ini dianggap sebagai dict hasil hierarkis.
Lihat tiga contoh dalam file ini:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan 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]
Parameter
Nama | Deskripsi |
---|---|
key_transformer
|
<xref:function>
Fungsi transformator kunci. |
keep_readonly
|
nilai default: True
|
Mengembalikan
Jenis | Deskripsi |
---|---|
Objek yang kompatibel dengan JSON dict |
deserialize
Uraikan str menggunakan sintaks RestAPI dan kembalikan model.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parameter
Nama | Deskripsi |
---|---|
data
Diperlukan
|
str menggunakan struktur RestAPI. JSON secara default. |
content_type
|
JSON secara default, atur aplikasi/xml jika XML. nilai default: None
|
Mengembalikan
Jenis | Deskripsi |
---|---|
Contoh model ini |
Pengecualian
Jenis | Deskripsi |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Mengurai dict menggunakan ekstraktor kunci yang diberikan mengembalikan model.
Secara default, pertimbangkan ekstraktor kunci (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor, dan 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
Parameter
Nama | Deskripsi |
---|---|
data
Diperlukan
|
Dict menggunakan struktur RestAPI |
content_type
|
JSON secara default, atur aplikasi/xml jika XML. nilai default: None
|
key_extractors
|
nilai default: None
|
Mengembalikan
Jenis | Deskripsi |
---|---|
Contoh model ini |
Pengecualian
Jenis | Deskripsi |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Mengembalikan JSON yang akan dikirim ke server dari model ini.
Ini adalah alias untuk as_dict(full_restapi_key_transformer, keep_readonly=False).
Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parameter
Nama | Deskripsi |
---|---|
keep_readonly
|
Jika Anda ingin menserialisasikan atribut readonly nilai default: False
|
Mengembalikan
Jenis | Deskripsi |
---|---|
Objek yang kompatibel dengan JSON dict |
Azure SDK for Python
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk