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)
키워드 전용 매개 변수
Name | 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 Key Vault 만드는 암호화 키에 대한 설명입니다. 이 키는 Microsoft가 아닌 누구도 암호를 해독할 수 없다는 완전한 보증을 원할 때 인덱서 정의에 대한 추가 수준의 미사용 암호화(및 인덱서 실행 상태)를 제공하는 데 사용됩니다. 인덱서 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전하려는 경우 필요에 따라 이 속성을 변경할 수 있습니다. 인덱서 정의(및 인덱서 실행 상태)는 영향을 받지 않습니다. 고객 관리형 키를 사용하는 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 또는 그 이후에 생성된 유료 서비스에만 사용할 수 있습니다. |
변수
Name | 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 Key Vault 만드는 암호화 키에 대한 설명입니다. 이 키는 Microsoft가 아닌 누구도 암호를 해독할 수 없다는 완전한 보증을 원할 때 인덱서 정의에 대한 추가 수준의 미사용 암호화(및 인덱서 실행 상태)를 제공하는 데 사용됩니다. 인덱서 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전하려는 경우 필요에 따라 이 속성을 변경할 수 있습니다. 인덱서 정의(및 인덱서 실행 상태)는 영향을 받지 않습니다. 고객 관리형 키를 사용하는 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 또는 그 이후에 생성된 유료 서비스에만 사용할 수 있습니다. |
메서드
as_dict |
json.dump를 사용하여 serialize할 수 있는 dict를 반환합니다. 고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다. 키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식의 'type'과 RestAPI로 인코딩된 키가 있는 'key'가 포함되어 있습니다. Value는 이 개체의 현재 값입니다. 반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다. 이 파일의 세 가지 예제를 참조하세요.
XML serialization을 원하는 경우 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 serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다. |
as_dict
json.dump를 사용하여 serialize할 수 있는 dict를 반환합니다.
고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다.
키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식의 'type'과 RestAPI로 인코딩된 키가 있는 'key'가 포함되어 있습니다. Value는 이 개체의 현재 값입니다.
반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다.
이 파일의 세 가지 예제를 참조하세요.
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML serialization을 원하는 경우 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]
매개 변수
Name | Description |
---|---|
key_transformer
|
<xref:function>
키 변환기 함수입니다. |
keep_readonly
|
기본값: True
|
반환
형식 | Description |
---|---|
dict JSON 호환 개체 |
deserialize
RestAPI 구문을 사용하여 str을 구문 분석하고 모델을 반환합니다.
deserialize(data: Any, content_type: str | None = None) -> ModelType
매개 변수
Name | Description |
---|---|
data
필수
|
RestAPI 구조를 사용하는 str입니다. 기본적으로 JSON입니다. |
content_type
|
기본적으로 JSON은 XML인 경우 application/xml을 설정합니다. 기본값: None
|
반환
형식 | Description |
---|---|
이 모델의 instance |
예외
형식 | Description |
---|---|
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
매개 변수
Name | Description |
---|---|
data
필수
|
RestAPI 구조를 사용하는 받아쓰기 |
content_type
|
기본적으로 JSON은 XML인 경우 application/xml을 설정합니다. 기본값: None
|
key_extractors
|
기본값: None
|
반환
형식 | Description |
---|---|
이 모델의 instance |
예외
형식 | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
이 모델에서 서버로 보낼 JSON을 반환합니다.
이는 as_dict(full_restapi_key_transformer, keep_readonly=False)에 대한 별칭입니다.
XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
매개 변수
Name | Description |
---|---|
keep_readonly
|
읽기 전용 특성을 직렬화하려는 경우 기본값: False
|
반환
형식 | Description |
---|---|
dict JSON 호환 개체 |
Azure SDK for Python