azure.search.documents.indexes.models.SearchServiceCounters.yml

### YamlMime:PythonClass
uid: azure.search.documents.indexes.models.SearchServiceCounters
name: SearchServiceCounters
fullName: azure.search.documents.indexes.models.SearchServiceCounters
module: azure.search.documents.indexes.models
inheritances:
- azure.search.documents.indexes._generated._serialization.Model
summary: 'Represents service-level resource counters and quotas.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'SearchServiceCounters(*, document_counter: _models.ResourceCounter, index_counter:
    _models.ResourceCounter, indexer_counter: _models.ResourceCounter, data_source_counter:
    _models.ResourceCounter, storage_size_counter: _models.ResourceCounter, synonym_map_counter:
    _models.ResourceCounter, skillset_counter: _models.ResourceCounter, vector_index_size_counter:
    _models.ResourceCounter, **kwargs: Any)'
  keywordOnlyParameters:
  - name: document_counter
    description: 'Total number of documents across all indexes in the service.

      Required.'
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: index_counter
    description: Total number of indexes. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: indexer_counter
    description: Total number of indexers. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: data_source_counter
    description: Total number of data sources. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: storage_size_counter
    description: Total size of used storage in bytes. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: synonym_map_counter
    description: Total number of synonym maps. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: skillset_counter
    description: Total number of skillsets. Required.
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
  - name: vector_index_size_counter
    description: 'Total memory consumption of all vector indexes within the

      service, in bytes. Required.'
    types:
    - <xref:azure.search.documents.indexes.models.ResourceCounter>
variables:
- description: Total number of documents across all indexes in the service. Required.
  name: document_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total number of indexes. Required.
  name: index_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total number of indexers. Required.
  name: indexer_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total number of data sources. Required.
  name: data_source_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total size of used storage in bytes. Required.
  name: storage_size_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total number of synonym maps. Required.
  name: synonym_map_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: Total number of skillsets. Required.
  name: skillset_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
- description: 'Total memory consumption of all vector indexes within the

    service, in bytes. Required.'
  name: vector_index_size_counter
  types:
  - <xref:azure.search.documents.indexes.models.ResourceCounter>
methods:
- uid: azure.search.documents.indexes.models.SearchServiceCounters.as_dict
  name: as_dict
  summary: "Return a dict that can be serialized using json.dump.\n\nAdvanced usage\
    \ might optionally use a callback as parameter:\n\nKey is the attribute name used\
    \ in Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with\
    \ the\nmsrest type and 'key' with the RestAPI encoded key.\nValue is the current\
    \ value in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: '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]'
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.search.documents.indexes.models.SearchServiceCounters.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: 'deserialize(data: Any, content_type: str | None = None) -> ModelType'
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.search.documents.indexes.models.SearchServiceCounters.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending() -> None
- uid: azure.search.documents.indexes.models.SearchServiceCounters.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: 'from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any],
    Any], Any] | None = None, content_type: str | None = None) -> ModelType'
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.search.documents.indexes.models.SearchServiceCounters.is_xml_model
  name: is_xml_model
  signature: is_xml_model() -> bool
- uid: azure.search.documents.indexes.models.SearchServiceCounters.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to server from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: 'serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str,
    Any]'
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>