SearchServiceCounters Class
Represents service-level resource counters and quotas.
Constructor
SearchServiceCounters(*args: Any, **kwargs: Any)Variables
| Name | Description |
|---|---|
|
alias_counter
|
Total number of aliases. Required. |
|
document_counter
|
Total number of documents across all indexes in the service. Required. |
|
index_counter
|
Total number of indexes. Required. |
|
indexer_counter
|
Total number of indexers. Required. |
|
data_source_counter
|
Total number of data sources. Required. |
|
storage_size_counter
|
Total size of used storage in bytes. Required. |
|
synonym_map_counter
|
Total number of synonym maps. Required. |
|
skillset_counter
|
Total number of skillsets. Required. |
|
vector_index_size_counter
|
Total memory consumption of all vector indexes within the service, in bytes. Required. |
|
knowledge_base_counter
|
Total number of knowledge bases. Required. |
|
knowledge_source_counter
|
Total number of knowledge sources. Required. |
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() -> Nonecopy
copy() -> Modelget
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) -> AnyParameters
| 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>) -> AnyParameters
| 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>) -> AnyParameters
| 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) -> Nonevalues
values() -> ValuesView[Any]Returns
| Type | Description |
|---|---|
|
an object providing a view on the mapping's values |
Attributes
alias_counter
Total number of aliases. Required.
alias_counter: _models.ResourceCounterdata_source_counter
Total number of data sources. Required.
data_source_counter: _models.ResourceCounterdocument_counter
Total number of documents across all indexes in the service. Required.
document_counter: _models.ResourceCounterindex_counter
Total number of indexes. Required.
index_counter: _models.ResourceCounterindexer_counter
Total number of indexers. Required.
indexer_counter: _models.ResourceCounterknowledge_base_counter
Total number of knowledge bases. Required.
knowledge_base_counter: _models.ResourceCounterknowledge_source_counter
Total number of knowledge sources. Required.
knowledge_source_counter: _models.ResourceCounterskillset_counter
Total number of skillsets. Required.
skillset_counter: _models.ResourceCounterstorage_size_counter
Total size of used storage in bytes. Required.
storage_size_counter: _models.ResourceCountersynonym_map_counter
Total number of synonym maps. Required.
synonym_map_counter: _models.ResourceCountervector_index_size_counter
Total memory consumption of all vector indexes within the service, in bytes. Required.
vector_index_size_counter: _models.ResourceCounter