IndexerCurrentState Class
Represents all of the state that defines and dictates the indexer's current execution.
Constructor
IndexerCurrentState(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
mode
|
str or
IndexingMode
The mode the indexer is running in. Known values are: "indexingAllDocs", "indexingResetDocs", and "indexingResync". |
|
all_docs_initial_tracking_state
|
Change tracking state used when indexing starts on all documents in the datasource. |
|
all_docs_final_tracking_state
|
Change tracking state value when indexing finishes on all documents in the datasource. |
|
reset_docs_initial_tracking_state
|
Change tracking state used when indexing starts on select, reset documents in the datasource. |
|
reset_docs_final_tracking_state
|
Change tracking state value when indexing finishes on select, reset documents in the datasource. |
|
resync_initial_tracking_state
|
Change tracking state used when indexing starts on selective options from the datasource. |
|
resync_final_tracking_state
|
Change tracking state value when indexing finishes on selective options from the datasource. |
|
reset_document_keys
|
The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys. |
|
reset_datasource_document_ids
|
The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. |
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
all_docs_final_tracking_state
Change tracking state value when indexing finishes on all documents in the datasource.
all_docs_final_tracking_state: str | None
all_docs_initial_tracking_state
Change tracking state used when indexing starts on all documents in the datasource.
all_docs_initial_tracking_state: str | None
mode
"indexingAllDocs", "indexingResetDocs", and "indexingResync".
mode: str | _models.IndexingMode | None
reset_datasource_document_ids
The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
reset_datasource_document_ids: list[str] | None
reset_docs_final_tracking_state
Change tracking state value when indexing finishes on select, reset documents in the datasource.
reset_docs_final_tracking_state: str | None
reset_docs_initial_tracking_state
Change tracking state used when indexing starts on select, reset documents in the datasource.
reset_docs_initial_tracking_state: str | None
reset_document_keys
The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
reset_document_keys: list[str] | None
resync_final_tracking_state
Change tracking state value when indexing finishes on selective options from the datasource.
resync_final_tracking_state: str | None
resync_initial_tracking_state
Change tracking state used when indexing starts on selective options from the datasource.
resync_initial_tracking_state: str | None