KeyRangeInfo (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.KeyRangeInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class KeyRangeInfo
extends com.google.api.client.json.GenericJson
```
A message representing information for a key range (possibly one key).
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

KeyRangeInfo()

Constructors
Constructor and Description
`KeyRangeInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyRangeInfo`	`clone()`
`List<ContextValue>`	`getContextValues()` The list of context values for this key range.
`Integer`	`getEndKeyIndex()` The index of the end key in indexed_keys.
`LocalizedString`	`getInfo()` Information about this key range, for all metrics.
`Long`	`getKeysCount()` The number of keys this range covers.
`LocalizedString`	`getMetric()` The name of the metric.
`Integer`	`getStartKeyIndex()` The index of the start key in indexed_keys.
`String`	`getTimeOffset()` The time offset.
`LocalizedString`	`getUnit()` The unit of the metric.
`Float`	`getValue()` The value of the metric.
`KeyRangeInfo`	`set(String fieldName, Object value)`
`KeyRangeInfo`	`setContextValues(List<ContextValue> contextValues)` The list of context values for this key range.
`KeyRangeInfo`	`setEndKeyIndex(Integer endKeyIndex)` The index of the end key in indexed_keys.
`KeyRangeInfo`	`setInfo(LocalizedString info)` Information about this key range, for all metrics.
`KeyRangeInfo`	`setKeysCount(Long keysCount)` The number of keys this range covers.
`KeyRangeInfo`	`setMetric(LocalizedString metric)` The name of the metric.
`KeyRangeInfo`	`setStartKeyIndex(Integer startKeyIndex)` The index of the start key in indexed_keys.
`KeyRangeInfo`	`setTimeOffset(String timeOffset)` The time offset.
`KeyRangeInfo`	`setUnit(LocalizedString unit)` The unit of the metric.
`KeyRangeInfo`	`setValue(Float value)` The value of the metric.

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
  - KeyRangeInfo
```
public KeyRangeInfo()
```
- Method Detail
  - getContextValues
```
public List<ContextValue> getContextValues()
```
    The list of context values for this key range.
    
    Returns:
    
    value or null for none
  - setContextValues
```
public KeyRangeInfo setContextValues(List<ContextValue> contextValues)
```
    The list of context values for this key range.
    
    Parameters:
    
    contextValues - contextValues or null for none
  - getEndKeyIndex
```
public Integer getEndKeyIndex()
```
    The index of the end key in indexed_keys.
    
    Returns:
    
    value or null for none
  - setEndKeyIndex
```
public KeyRangeInfo setEndKeyIndex(Integer endKeyIndex)
```
    The index of the end key in indexed_keys.
    
    Parameters:
    
    endKeyIndex - endKeyIndex or null for none
  - getInfo
```
public LocalizedString getInfo()
```
    Information about this key range, for all metrics.
    
    Returns:
    
    value or null for none
  - setInfo
```
public KeyRangeInfo setInfo(LocalizedString info)
```
    Information about this key range, for all metrics.
    
    Parameters:
    
    info - info or null for none
  - getKeysCount
```
public Long getKeysCount()
```
    The number of keys this range covers.
    
    Returns:
    
    value or null for none
  - setKeysCount
```
public KeyRangeInfo setKeysCount(Long keysCount)
```
    The number of keys this range covers.
    
    Parameters:
    
    keysCount - keysCount or null for none
  - getMetric
```
public LocalizedString getMetric()
```
    The name of the metric. e.g. "latency".
    
    Returns:
    
    value or null for none
  - setMetric
```
public KeyRangeInfo setMetric(LocalizedString metric)
```
    The name of the metric. e.g. "latency".
    
    Parameters:
    
    metric - metric or null for none
  - getStartKeyIndex
```
public Integer getStartKeyIndex()
```
    The index of the start key in indexed_keys.
    
    Returns:
    
    value or null for none
  - setStartKeyIndex
```
public KeyRangeInfo setStartKeyIndex(Integer startKeyIndex)
```
    The index of the start key in indexed_keys.
    
    Parameters:
    
    startKeyIndex - startKeyIndex or null for none
  - getTimeOffset
```
public String getTimeOffset()
```
    The time offset. This is the time since the start of the time interval.
    
    Returns:
    
    value or null for none
  - setTimeOffset
```
public KeyRangeInfo setTimeOffset(String timeOffset)
```
    The time offset. This is the time since the start of the time interval.
    
    Parameters:
    
    timeOffset - timeOffset or null for none
  - getUnit
```
public LocalizedString getUnit()
```
    The unit of the metric. This is an unstructured field and will be mapped as is to the user.
    
    Returns:
    
    value or null for none
  - setUnit
```
public KeyRangeInfo setUnit(LocalizedString unit)
```
    The unit of the metric. This is an unstructured field and will be mapped as is to the user.
    
    Parameters:
    
    unit - unit or null for none
  - getValue
```
public Float getValue()
```
    The value of the metric.
    
    Returns:
    
    value or null for none
  - setValue
```
public KeyRangeInfo setValue(Float value)
```
    The value of the metric.
    
    Parameters:
    
    value - value or null for none
  - set
```
public KeyRangeInfo set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public KeyRangeInfo clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class KeyRangeInfo

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

KeyRangeInfo

Method Detail

getContextValues

setContextValues

getEndKeyIndex

setEndKeyIndex

getInfo

setInfo

getKeysCount

setKeysCount

getMetric

setMetric

getStartKeyIndex

setStartKeyIndex

getTimeOffset

setTimeOffset

getUnit

setUnit

getValue

setValue

set

clone