Metric (Cloud Spanner API v1-rev20250708-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.spanner.v1.model.Metric

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Metric
extends com.google.api.client.json.GenericJson
```
A message representing the actual monitoring data, values for each key bucket over time, of a metric.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Metric()

Constructors
Constructor and Description
`Metric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Metric`	`clone()`
`String`	`getAggregation()` The aggregation function used to aggregate each key bucket
`LocalizedString`	`getCategory()` The category of the metric, e.g.
`DerivedMetric`	`getDerived()` The references to numerator and denominator metrics for a derived metric.
`LocalizedString`	`getDisplayLabel()` The displayed label of the metric.
`Boolean`	`getHasNonzeroData()` Whether the metric has any non-zero data.
`Float`	`getHotValue()` The value that is considered hot for the metric.
`Map<String,IndexedHotKey>`	`getIndexedHotKeys()` The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.
`Map<String,IndexedKeyRangeInfos>`	`getIndexedKeyRangeInfos()` The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.
`LocalizedString`	`getInfo()` Information about the metric.
`MetricMatrix`	`getMatrix()` The data for the metric as a matrix.
`LocalizedString`	`getUnit()` The unit of the metric.
`Boolean`	`getVisible()` Whether the metric is visible to the end user.
`Metric`	`set(String fieldName, Object value)`
`Metric`	`setAggregation(String aggregation)` The aggregation function used to aggregate each key bucket
`Metric`	`setCategory(LocalizedString category)` The category of the metric, e.g.
`Metric`	`setDerived(DerivedMetric derived)` The references to numerator and denominator metrics for a derived metric.
`Metric`	`setDisplayLabel(LocalizedString displayLabel)` The displayed label of the metric.
`Metric`	`setHasNonzeroData(Boolean hasNonzeroData)` Whether the metric has any non-zero data.
`Metric`	`setHotValue(Float hotValue)` The value that is considered hot for the metric.
`Metric`	`setIndexedHotKeys(Map<String,IndexedHotKey> indexedHotKeys)` The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.
`Metric`	`setIndexedKeyRangeInfos(Map<String,IndexedKeyRangeInfos> indexedKeyRangeInfos)` The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.
`Metric`	`setInfo(LocalizedString info)` Information about the metric.
`Metric`	`setMatrix(MetricMatrix matrix)` The data for the metric as a matrix.
`Metric`	`setUnit(LocalizedString unit)` The unit of the metric.
`Metric`	`setVisible(Boolean visible)` Whether the metric is visible to the end user.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Metric
```
public Metric()
```
- Method Detail
  - getAggregation
```
public String getAggregation()
```
    The aggregation function used to aggregate each key bucket
    
    Returns:
    
    value or null for none
  - setAggregation
```
public Metric setAggregation(String aggregation)
```
    The aggregation function used to aggregate each key bucket
    
    Parameters:
    
    aggregation - aggregation or null for none
  - getCategory
```
public LocalizedString getCategory()
```
    The category of the metric, e.g. "Activity", "Alerts", "Reads", etc.
    
    Returns:
    
    value or null for none
  - setCategory
```
public Metric setCategory(LocalizedString category)
```
    The category of the metric, e.g. "Activity", "Alerts", "Reads", etc.
    
    Parameters:
    
    category - category or null for none
  - getDerived
```
public DerivedMetric getDerived()
```
    The references to numerator and denominator metrics for a derived metric.
    
    Returns:
    
    value or null for none
  - setDerived
```
public Metric setDerived(DerivedMetric derived)
```
    The references to numerator and denominator metrics for a derived metric.
    
    Parameters:
    
    derived - derived or null for none
  - getDisplayLabel
```
public LocalizedString getDisplayLabel()
```
    The displayed label of the metric.
    
    Returns:
    
    value or null for none
  - setDisplayLabel
```
public Metric setDisplayLabel(LocalizedString displayLabel)
```
    The displayed label of the metric.
    
    Parameters:
    
    displayLabel - displayLabel or null for none
  - getHasNonzeroData
```
public Boolean getHasNonzeroData()
```
    Whether the metric has any non-zero data.
    
    Returns:
    
    value or null for none
  - setHasNonzeroData
```
public Metric setHasNonzeroData(Boolean hasNonzeroData)
```
    Whether the metric has any non-zero data.
    
    Parameters:
    
    hasNonzeroData - hasNonzeroData or null for none
  - getHotValue
```
public Float getHotValue()
```
    The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales.
    
    Returns:
    
    value or null for none
  - setHotValue
```
public Metric setHotValue(Float hotValue)
```
    The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales.
    
    Parameters:
    
    hotValue - hotValue or null for none
  - getIndexedHotKeys
```
public Map<String,IndexedHotKey> getIndexedHotKeys()
```
    The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.
    
    Returns:
    
    value or null for none
  - setIndexedHotKeys
```
public Metric setIndexedHotKeys(Map<String,IndexedHotKey> indexedHotKeys)
```
    The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.
    
    Parameters:
    
    indexedHotKeys - indexedHotKeys or null for none
  - getIndexedKeyRangeInfos
```
public Map<String,IndexedKeyRangeInfos> getIndexedKeyRangeInfos()
```
    The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.
    
    Returns:
    
    value or null for none
  - setIndexedKeyRangeInfos
```
public Metric setIndexedKeyRangeInfos(Map<String,IndexedKeyRangeInfos> indexedKeyRangeInfos)
```
    The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.
    
    Parameters:
    
    indexedKeyRangeInfos - indexedKeyRangeInfos or null for none
  - getInfo
```
public LocalizedString getInfo()
```
    Information about the metric.
    
    Returns:
    
    value or null for none
  - setInfo
```
public Metric setInfo(LocalizedString info)
```
    Information about the metric.
    
    Parameters:
    
    info - info or null for none
  - getMatrix
```
public MetricMatrix getMatrix()
```
    The data for the metric as a matrix.
    
    Returns:
    
    value or null for none
  - setMatrix
```
public Metric setMatrix(MetricMatrix matrix)
```
    The data for the metric as a matrix.
    
    Parameters:
    
    matrix - matrix or null for none
  - getUnit
```
public LocalizedString getUnit()
```
    The unit of the metric.
    
    Returns:
    
    value or null for none
  - setUnit
```
public Metric setUnit(LocalizedString unit)
```
    The unit of the metric.
    
    Parameters:
    
    unit - unit or null for none
  - getVisible
```
public Boolean getVisible()
```
    Whether the metric is visible to the end user.
    
    Returns:
    
    value or null for none
  - setVisible
```
public Metric setVisible(Boolean visible)
```
    Whether the metric is visible to the end user.
    
    Parameters:
    
    visible - visible or null for none
  - set
```
public Metric set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Metric clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Metric

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Metric

Method Detail

getAggregation

setAggregation

getCategory

setCategory

getDerived

setDerived

getDisplayLabel

setDisplayLabel

getHasNonzeroData

setHasNonzeroData

getHotValue

setHotValue

getIndexedHotKeys

setIndexedHotKeys

getIndexedKeyRangeInfos

setIndexedKeyRangeInfos

getInfo

setInfo

getMatrix

setMatrix

getUnit

setUnit

getVisible

setVisible

set

clone