com.google.api.services.monitoring.v3.model

Class Exemplar

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.Exemplar

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Exemplar
extends com.google.api.client.json.GenericJson

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

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 Stackdriver Monitoring 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Exemplar()

Method Summary

Modifier and Type	Method and Description
Exemplar	clone()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getAttachments() Contextual information about the example value.
java.lang.String	getTimestamp() The observation (sampling) time of the above value.
java.lang.Double	getValue() Value of the exemplar point.
Exemplar	set(java.lang.String fieldName, java.lang.Object value)
Exemplar	setAttachments(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> attachments) Contextual information about the example value.
Exemplar	setTimestamp(java.lang.String timestamp) The observation (sampling) time of the above value.
Exemplar	setValue(java.lang.Double value) Value of the exemplar point.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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

Exemplar

public Exemplar()

Method Detail

getAttachments

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAttachments()

Contextual information about the example value. Examples are:Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.TraceLiteral string: type.googleapis.com/google.protobuf.StringValueLabels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

Returns:

value or null for none

setAttachments

public Exemplar setAttachments(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> attachments)

Contextual information about the example value. Examples are:Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.TraceLiteral string: type.googleapis.com/google.protobuf.StringValueLabels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

Parameters:

attachments - attachments or null for none

getTimestamp

public java.lang.String getTimestamp()

The observation (sampling) time of the above value.

Returns:

value or null for none

setTimestamp

public Exemplar setTimestamp(java.lang.String timestamp)

The observation (sampling) time of the above value.

Parameters:

timestamp - timestamp or null for none

getValue

public java.lang.Double getValue()

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

Returns:

value or null for none

setValue

public Exemplar setValue(java.lang.Double value)

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

Parameters:

value - value or null for none

set

public Exemplar set(java.lang.String fieldName,
                    java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Exemplar clone()

Overrides:

clone in class com.google.api.client.json.GenericJson