Class: Google::Apis::MonitoringV3::Exemplar

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Exemplar

Returns a new instance of Exemplar



862
863
864
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 862

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attachments ⇒ Array<Hash<String,Object>>

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. Corresponds to the JSON property attachments

Returns:

  • (Array<Hash<String,Object>>) 


849
850
851
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 849

def attachments
  @attachments
end

#timestamp ⇒ String

The observation (sampling) time of the above value. Corresponds to the JSON property timestamp

Returns:

  • (String) 


854
855
856
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 854

def timestamp
  @timestamp
end

#value ⇒ Float

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

Returns:

  • (Float) 


860
861
862
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 860

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



867
868
869
870
871
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 867

def update!(**args)
  @attachments = args[:attachments] if args.key?(:attachments)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @value = args[:value] if args.key?(:value)
end