IndexerExecutionResult Class

Represents the result of an individual indexer execution.

Constructor

IndexerExecutionResult(*args: Any, **kwargs: Any)

Variables

Name Description
status

The outcome of this indexer execution. Required. Known values are: "transientFailure", "success", "inProgress", and "reset".

status_detail

The outcome of this indexer execution. Known values are: "resetDocs" and "resync".

mode

The mode the indexer is running in. Known values are: "indexingAllDocs", "indexingResetDocs", and "indexingResync".

error_message
str

The error message indicating the top-level error, if any.

start_time

The start time of this indexer execution.

end_time

The end time of this indexer execution, if the execution has already completed.

errors

The item-level indexing errors. Required.

warnings

The item-level indexing warnings. Required.

item_count
int

The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. Required.

failed_item_count
int

The number of items that failed to be indexed during this indexer execution. Required.

initial_tracking_state
str

Change tracking state with which an indexer execution started.

final_tracking_state
str

Change tracking state with which an indexer execution finished.

Methods

as_dict

Return a dict that can be turned into json using json.dump.

clear

Remove all items from the dictionary.

copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type Description

a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type Description

a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type Description

an object providing a view on the mapping's values

Attributes

end_time

The end time of this indexer execution, if the execution has already completed.

end_time: datetime | None

error_message

The error message indicating the top-level error, if any.

error_message: str | None

errors

The item-level indexing errors. Required.

errors: list['_models.SearchIndexerError']

failed_item_count

The number of items that failed to be indexed during this indexer execution. Required.

failed_item_count: int

final_tracking_state

Change tracking state with which an indexer execution finished.

final_tracking_state: str | None

initial_tracking_state

Change tracking state with which an indexer execution started.

initial_tracking_state: str | None

item_count

The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. Required.

item_count: int

mode

"indexingAllDocs", "indexingResetDocs", and "indexingResync".

mode: str | _models.IndexingMode | None

start_time

The start time of this indexer execution.

start_time: datetime | None

status

"transientFailure", "success", "inProgress", and "reset".

status: str | _models.IndexerExecutionStatus

status_detail

"resetDocs" and "resync".

status_detail: str | _models.IndexerExecutionStatusDetail | None

warnings

The item-level indexing warnings. Required.

warnings: list['_models.SearchIndexerWarning']