Cloud Logging V2 API - Class Google::Api::Distribution::Exemplar (v0.12.2)

Reference documentation and code samples for the Cloud Logging V2 API class Google::Api::Distribution::Exemplar.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attachments

def attachments() -> ::Array<::Google::Protobuf::Any>
Returns
  • (::Array<::Google::Protobuf::Any>) — 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.

#attachments=

def attachments=(value) -> ::Array<::Google::Protobuf::Any>
Parameter
  • value (::Array<::Google::Protobuf::Any>) — 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.

Returns
  • (::Array<::Google::Protobuf::Any>) — 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.

#timestamp

def timestamp() -> ::Google::Protobuf::Timestamp
Returns

#timestamp=

def timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#value

def value() -> ::Float
Returns
  • (::Float) — Value of the exemplar point. This value determines to which bucket the exemplar belongs.

#value=

def value=(value) -> ::Float
Parameter
  • value (::Float) — Value of the exemplar point. This value determines to which bucket the exemplar belongs.
Returns
  • (::Float) — Value of the exemplar point. This value determines to which bucket the exemplar belongs.