Reference documentation and code samples for the Google API Common Protos Client class 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.
Generated from protobuf message google.api.Distribution.Exemplar
Namespace
Google \ Api \ DistributionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ value |
float
Value of the exemplar point. This value determines to which bucket the exemplar belongs. |
↳ timestamp |
Google\Protobuf\Timestamp
The observation (sampling) time of the above value. |
↳ attachments |
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. |
getValue
Value of the exemplar point. This value determines to which bucket the exemplar belongs.
| Returns | |
|---|---|
| Type | Description |
float |
|
setValue
Value of the exemplar point. This value determines to which bucket the exemplar belongs.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimestamp
The observation (sampling) time of the above value.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasTimestamp
clearTimestamp
setTimestamp
The observation (sampling) time of the above value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAttachments
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAttachments
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Any>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|