Class: Google::Apis::FileV1::Exemplar

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/file_v1/classes.rb,
generated/google/apis/file_v1/representations.rb,
generated/google/apis/file_v1/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.



266
267
268
# File 'generated/google/apis/file_v1/classes.rb', line 266

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

Instance Attribute Details

#attachmentsArray<Hash<String,Object>>

Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There 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>>)


253
254
255
# File 'generated/google/apis/file_v1/classes.rb', line 253

def attachments
  @attachments
end

#timestampString

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

Returns:

  • (String)


258
259
260
# File 'generated/google/apis/file_v1/classes.rb', line 258

def timestamp
  @timestamp
end

#valueFloat

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

Returns:

  • (Float)


264
265
266
# File 'generated/google/apis/file_v1/classes.rb', line 264

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



271
272
273
274
275
# File 'generated/google/apis/file_v1/classes.rb', line 271

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