1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Distribution
  7. \
  8. Exemplar

Exemplar

class Exemplar extends Message

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.

Generated from protobuf message google.api.Distribution.Exemplar

Methods

__construct(array $data = NULL)

Constructor.

float
getValue()

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

$this
setValue(float $var)

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

Timestamp
getTimestamp()

The observation (sampling) time of the above value.

$this
setTimestamp(Timestamp $var)

The observation (sampling) time of the above value.

RepeatedField
getAttachments()

Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace 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.

$this
setAttachments(Any[]|RepeatedField $var)

Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace 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.

Details

at line 69
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type float $value
      Value of the exemplar point. This value determines to which bucket the
      exemplar belongs.
@type \Google\Protobuf\Timestamp $timestamp
      The observation (sampling) time of the above value.
@type \Google\Protobuf\Any[]|\Google\Protobuf\Internal\RepeatedField $attachments
      Contextual information about the example value. Examples are:
        Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
        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.

}

at line 81
float getValue()

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

Generated from protobuf field double value = 1;

Return Value

float

at line 94
$this setValue(float $var)

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

Generated from protobuf field double value = 1;

Parameters

float $var

Return Value

$this

at line 108
Timestamp getTimestamp()

The observation (sampling) time of the above value.

Generated from protobuf field .google.protobuf.Timestamp timestamp = 2;

Return Value

Timestamp

at line 120
$this setTimestamp(Timestamp $var)

The observation (sampling) time of the above value.

Generated from protobuf field .google.protobuf.Timestamp timestamp = 2;

Parameters

Timestamp $var

Return Value

$this

at line 140
RepeatedField getAttachments()

Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace 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.

Generated from protobuf field repeated .google.protobuf.Any attachments = 3;

Return Value

RepeatedField

at line 158
$this setAttachments(Any[]|RepeatedField $var)

Contextual information about the example value. Examples are: Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace 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.

Generated from protobuf field repeated .google.protobuf.Any attachments = 3;

Parameters

Any[]|RepeatedField $var

Return Value

$this