IndexingResult 클래스
단일 문서에 대한 인덱싱 작업의 상태입니다.
변수는 서버에서만 채워지고 요청을 보낼 때 무시됩니다.
Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.
- 상속
-
azure.search.documents._generated._serialization.ModelIndexingResult
생성자
IndexingResult(**kwargs: Any)
변수
Name | Description |
---|---|
key
|
인덱싱 요청에 있던 문서의 키입니다. 필수 사항입니다. |
error_message
|
키로 식별된 문서에 대해 인덱싱 작업이 실패한 이유를 설명하는 오류 메시지입니다. 인덱싱에 성공하면 null입니다. |
succeeded
|
키로 식별된 문서에 대해 인덱싱 작업이 성공했는지 여부를 나타내는 값입니다. 필수 사항입니다. |
status_code
|
인덱싱 작업의 상태 코드입니다. 가능한 값은 성공적인 업데이트 또는 삭제의 경우 200, 문서 만들기 성공 201, 잘못된 입력 문서의 경우 400, 문서를 찾을 수 없는 경우 404, 버전 충돌의 경우 409, 인덱스가 일시적으로 사용할 수 없는 경우 422, 서비스가 너무 바쁠 때 503입니다. 필수 사항입니다. |
메서드
as_dict |
json.dump를 사용하여 serialize할 수 있는 받아쓰기를 반환합니다. 고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다. 키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식이 있는 'type'과 RestAPI 인코딩된 키가 있는 'key'가 포함되어 있습니다. 값은 이 개체의 현재 값입니다. 반환된 문자열은 키를 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할 수 있는 받아쓰기를 반환합니다.
고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다.
키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식이 있는 'type'과 RestAPI 인코딩된 키가 있는 'key'가 포함되어 있습니다. 값은 이 개체의 현재 값입니다.
반환된 문자열은 키를 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