Share via

SearchServiceCounters Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.4
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchServiceCounters

Implements

JsonSerializable<SearchServiceCounters>

public final class SearchServiceCounters
implements JsonSerializable<SearchServiceCounters>

Represents service-level resource counters and quotas.

Constructor Summary

Constructor Description
SearchServiceCounters(ResourceCounter documentCounter, ResourceCounter indexCounter, ResourceCounter indexerCounter, ResourceCounter dataSourceCounter, ResourceCounter storageSizeCounter, ResourceCounter synonymMapCounter)

Creates an instance of SearchServiceCounters class.

Method Summary

Modifier and Type Method and Description
static SearchServiceCounters fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceCounters from the JsonReader.
ResourceCounter getDataSourceCounter()

Get the dataSourceCounter property: Total number of data sources.
ResourceCounter getDocumentCounter()

Get the documentCounter property: Total number of documents across all indexes in the service.
ResourceCounter getIndexCounter()

Get the indexCounter property: Total number of indexes.
ResourceCounter getIndexerCounter()

Get the indexerCounter property: Total number of indexers.
ResourceCounter getSkillsetCounter()

Get the skillsetCounter property: Total number of skillsets.
ResourceCounter getStorageSizeCounter()

Get the storageSizeCounter property: Total size of used storage in bytes.
ResourceCounter getSynonymMapCounter()

Get the synonymMapCounter property: Total number of synonym maps.
ResourceCounter getVectorIndexSizeCounter()

Get the vectorIndexSizeCounter property: Total memory consumption of all vector indexes within the service, in bytes.
SearchServiceCounters setSkillsetCounter(ResourceCounter skillsetCounter)

Set the skillsetCounter property: Total number of skillsets.
SearchServiceCounters setVectorIndexSizeCounter(ResourceCounter vectorIndexSizeCounter)

Set the vectorIndexSizeCounter property: Total memory consumption of all vector indexes within the service, in bytes.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchServiceCounters

public SearchServiceCounters(ResourceCounter documentCounter, ResourceCounter indexCounter, ResourceCounter indexerCounter, ResourceCounter dataSourceCounter, ResourceCounter storageSizeCounter, ResourceCounter synonymMapCounter)

Creates an instance of SearchServiceCounters class.

Parameters:

documentCounter - the documentCounter value to set.
indexCounter - the indexCounter value to set.
indexerCounter - the indexerCounter value to set.
dataSourceCounter - the dataSourceCounter value to set.
storageSizeCounter - the storageSizeCounter value to set.
synonymMapCounter - the synonymMapCounter value to set.

Method Details

fromJson

public static SearchServiceCounters fromJson(JsonReader jsonReader)

Reads an instance of SearchServiceCounters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchServiceCounters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getDataSourceCounter

public ResourceCounter getDataSourceCounter()

Get the dataSourceCounter property: Total number of data sources.

Returns:

the dataSourceCounter value.

getDocumentCounter

public ResourceCounter getDocumentCounter()

Get the documentCounter property: Total number of documents across all indexes in the service.

Returns:

the documentCounter value.

getIndexCounter

public ResourceCounter getIndexCounter()

Get the indexCounter property: Total number of indexes.

Returns:

the indexCounter value.

getIndexerCounter

public ResourceCounter getIndexerCounter()

Get the indexerCounter property: Total number of indexers.

Returns:

the indexerCounter value.

getSkillsetCounter

public ResourceCounter getSkillsetCounter()

Get the skillsetCounter property: Total number of skillsets.

Returns:

the skillsetCounter value.

getStorageSizeCounter

public ResourceCounter getStorageSizeCounter()

Get the storageSizeCounter property: Total size of used storage in bytes.

Returns:

the storageSizeCounter value.

getSynonymMapCounter

public ResourceCounter getSynonymMapCounter()

Get the synonymMapCounter property: Total number of synonym maps.

Returns:

the synonymMapCounter value.

getVectorIndexSizeCounter

public ResourceCounter getVectorIndexSizeCounter()

Get the vectorIndexSizeCounter property: Total memory consumption of all vector indexes within the service, in bytes.

Returns:

the vectorIndexSizeCounter value.

setSkillsetCounter

public SearchServiceCounters setSkillsetCounter(ResourceCounter skillsetCounter)

Set the skillsetCounter property: Total number of skillsets.

Parameters:

skillsetCounter - the skillsetCounter value to set.

Returns:

the SearchServiceCounters object itself.

setVectorIndexSizeCounter

public SearchServiceCounters setVectorIndexSizeCounter(ResourceCounter vectorIndexSizeCounter)

Set the vectorIndexSizeCounter property: Total memory consumption of all vector indexes within the service, in bytes.

Parameters:

vectorIndexSizeCounter - the vectorIndexSizeCounter value to set.

Returns:

the SearchServiceCounters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to