Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. SummaryDataPoint.php

class SummaryDataPoint

SummaryDataPoint is a single data point in a timeseries that describes the time-varying values of a Summary metric.

Generated from protobuf message <code>opentelemetry.proto.metrics.v1.SummaryDataPoint</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Opentelemetry\Proto\Metrics\V1\SummaryDataPoint extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of SummaryDataPoint

File

vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Metrics/V1/SummaryDataPoint.php, line 17

Namespace

Opentelemetry\Proto\Metrics\V1
View source
class SummaryDataPoint extends \Google\Protobuf\Internal\Message {
    
    /**
     * The set of key/value pairs that uniquely identify the timeseries from
     * where this point belongs. The list may be empty (may contain 0 elements).
     * Attribute keys MUST be unique (it is not allowed to have more than one
     * attribute with the same key).
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;</code>
     */
    private $attributes;
    
    /**
     * StartTimeUnixNano is optional but strongly encouraged, see the
     * the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 start_time_unix_nano = 2;</code>
     */
    protected $start_time_unix_nano = 0;
    
    /**
     * TimeUnixNano is required, see the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 3;</code>
     */
    protected $time_unix_nano = 0;
    
    /**
     * count is the number of values in the population. Must be non-negative.
     *
     * Generated from protobuf field <code>fixed64 count = 4;</code>
     */
    protected $count = 0;
    
    /**
     * sum of the values in the population. If count is zero then this field
     * must be zero.
     * Note: Sum should only be filled out when measuring non-negative discrete
     * events, and is assumed to be monotonic over the values of these events.
     * Negative events *can* be recorded, but sum should not be filled out when
     * doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
     * see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#summary
     *
     * Generated from protobuf field <code>double sum = 5;</code>
     */
    protected $sum = 0.0;
    
    /**
     * (Optional) list of values at different quantiles of the distribution calculated
     * from the current snapshot. The quantiles must be strictly increasing.
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;</code>
     */
    private $quantile_values;
    
    /**
     * Flags that apply to this specific data point.  See DataPointFlags
     * for the available flags and their meaning.
     *
     * Generated from protobuf field <code>uint32 flags = 8;</code>
     */
    protected $flags = 0;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
     *           The set of key/value pairs that uniquely identify the timeseries from
     *           where this point belongs. The list may be empty (may contain 0 elements).
     *           Attribute keys MUST be unique (it is not allowed to have more than one
     *           attribute with the same key).
     *     @type int|string $start_time_unix_nano
     *           StartTimeUnixNano is optional but strongly encouraged, see the
     *           the detailed comments above Metric.
     *           Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     *           1970.
     *     @type int|string $time_unix_nano
     *           TimeUnixNano is required, see the detailed comments above Metric.
     *           Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     *           1970.
     *     @type int|string $count
     *           count is the number of values in the population. Must be non-negative.
     *     @type float $sum
     *           sum of the values in the population. If count is zero then this field
     *           must be zero.
     *           Note: Sum should only be filled out when measuring non-negative discrete
     *           events, and is assumed to be monotonic over the values of these events.
     *           Negative events *can* be recorded, but sum should not be filled out when
     *           doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
     *           see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#summary
     *     @type \Opentelemetry\Proto\Metrics\V1\SummaryDataPoint\ValueAtQuantile[]|\Google\Protobuf\Internal\RepeatedField $quantile_values
     *           (Optional) list of values at different quantiles of the distribution calculated
     *           from the current snapshot. The quantiles must be strictly increasing.
     *     @type int $flags
     *           Flags that apply to this specific data point.  See DataPointFlags
     *           for the available flags and their meaning.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Opentelemetry\Proto\Metrics\V1\Metrics::initOnce();
        parent::__construct($data);
    }
    
    /**
     * The set of key/value pairs that uniquely identify the timeseries from
     * where this point belongs. The list may be empty (may contain 0 elements).
     * Attribute keys MUST be unique (it is not allowed to have more than one
     * attribute with the same key).
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getAttributes() {
        return $this->attributes;
    }
    
    /**
     * The set of key/value pairs that uniquely identify the timeseries from
     * where this point belongs. The list may be empty (may contain 0 elements).
     * Attribute keys MUST be unique (it is not allowed to have more than one
     * attribute with the same key).
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;</code>
     * @param \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setAttributes($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Common\V1\KeyValue::class);
        $this->attributes = $arr;
        return $this;
    }
    
    /**
     * StartTimeUnixNano is optional but strongly encouraged, see the
     * the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 start_time_unix_nano = 2;</code>
     * @return int|string
     */
    public function getStartTimeUnixNano() {
        return $this->start_time_unix_nano;
    }
    
    /**
     * StartTimeUnixNano is optional but strongly encouraged, see the
     * the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 start_time_unix_nano = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setStartTimeUnixNano($var) {
        GPBUtil::checkUint64($var);
        $this->start_time_unix_nano = $var;
        return $this;
    }
    
    /**
     * TimeUnixNano is required, see the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 3;</code>
     * @return int|string
     */
    public function getTimeUnixNano() {
        return $this->time_unix_nano;
    }
    
    /**
     * TimeUnixNano is required, see the detailed comments above Metric.
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 3;</code>
     * @param int|string $var
     * @return $this
     */
    public function setTimeUnixNano($var) {
        GPBUtil::checkUint64($var);
        $this->time_unix_nano = $var;
        return $this;
    }
    
    /**
     * count is the number of values in the population. Must be non-negative.
     *
     * Generated from protobuf field <code>fixed64 count = 4;</code>
     * @return int|string
     */
    public function getCount() {
        return $this->count;
    }
    
    /**
     * count is the number of values in the population. Must be non-negative.
     *
     * Generated from protobuf field <code>fixed64 count = 4;</code>
     * @param int|string $var
     * @return $this
     */
    public function setCount($var) {
        GPBUtil::checkUint64($var);
        $this->count = $var;
        return $this;
    }
    
    /**
     * sum of the values in the population. If count is zero then this field
     * must be zero.
     * Note: Sum should only be filled out when measuring non-negative discrete
     * events, and is assumed to be monotonic over the values of these events.
     * Negative events *can* be recorded, but sum should not be filled out when
     * doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
     * see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#summary
     *
     * Generated from protobuf field <code>double sum = 5;</code>
     * @return float
     */
    public function getSum() {
        return $this->sum;
    }
    
    /**
     * sum of the values in the population. If count is zero then this field
     * must be zero.
     * Note: Sum should only be filled out when measuring non-negative discrete
     * events, and is assumed to be monotonic over the values of these events.
     * Negative events *can* be recorded, but sum should not be filled out when
     * doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
     * see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#summary
     *
     * Generated from protobuf field <code>double sum = 5;</code>
     * @param float $var
     * @return $this
     */
    public function setSum($var) {
        GPBUtil::checkDouble($var);
        $this->sum = $var;
        return $this;
    }
    
    /**
     * (Optional) list of values at different quantiles of the distribution calculated
     * from the current snapshot. The quantiles must be strictly increasing.
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getQuantileValues() {
        return $this->quantile_values;
    }
    
    /**
     * (Optional) list of values at different quantiles of the distribution calculated
     * from the current snapshot. The quantiles must be strictly increasing.
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;</code>
     * @param \Opentelemetry\Proto\Metrics\V1\SummaryDataPoint\ValueAtQuantile[]|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setQuantileValues($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Metrics\V1\SummaryDataPoint\ValueAtQuantile::class);
        $this->quantile_values = $arr;
        return $this;
    }
    
    /**
     * Flags that apply to this specific data point.  See DataPointFlags
     * for the available flags and their meaning.
     *
     * Generated from protobuf field <code>uint32 flags = 8;</code>
     * @return int
     */
    public function getFlags() {
        return $this->flags;
    }
    
    /**
     * Flags that apply to this specific data point.  See DataPointFlags
     * for the available flags and their meaning.
     *
     * Generated from protobuf field <code>uint32 flags = 8;</code>
     * @param int $var
     * @return $this
     */
    public function setFlags($var) {
        GPBUtil::checkUint32($var);
        $this->flags = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Message::$desc private property @ignore
Message::$unknown private property
Message::appendHelper private function
Message::byteSize public function @ignore
Message::clear public function Clear all containing fields.
Message::convertJsonValueToProtoValue private function
Message::defaultValue private function @ignore
Message::discardUnknownFields public function Clear all unknown fields previously parsed.
Message::existField private function @ignore
Message::fieldByteSize private function @ignore
Message::fieldDataOnlyByteSize private function @ignore
Message::fieldDataOnlyJsonByteSize private function @ignore
Message::fieldJsonByteSize private function @ignore
Message::hasOneof protected function
Message::initWithDescriptor private function @ignore
Message::initWithGeneratedPool private function @ignore
Message::jsonByteSize public function @ignore
Message::kvUpdateHelper private function
Message::mergeFrom public function Merges the contents of the specified message into current message.
Message::mergeFromArray protected function Populates the message from a user-supplied PHP array. Array keys
correspond to Message properties and nested message properties.
Message::mergeFromArrayJsonImpl private function
Message::mergeFromJsonArray protected function
Message::mergeFromJsonString public function Parses a json string to protobuf message.
Message::mergeFromString public function Parses a protocol buffer contained in a string.
Message::normalizeArrayElementsToMessageType private static function Tries to normalize the elements in $value into a provided protobuf
wrapper type $class. If $value is any type other than array, we do
not do any conversion, and instead rely on the existing protobuf
type checking. If $value is an array, we process…
Message::normalizeToMessageType private static function Tries to normalize $value into a provided protobuf wrapper type $class.
If $value is any type other than an object, we attempt to construct an
instance of $class and assign $value to it using the setValue method
shared by all wrapper types.
Message::parseFieldFromStream private function @ignore
Message::parseFieldFromStreamNoTag private static function @ignore
Message::parseFromJsonStream public function @ignore
Message::parseFromStream public function @ignore
Message::readOneof protected function
Message::readWrapperValue protected function
Message::repeatedFieldDataOnlyByteSize private function @ignore
Message::serializeFieldToJsonStream private function @ignore
Message::serializeFieldToStream private function @ignore
Message::serializeMapFieldToStream private function @ignore
Message::serializeRepeatedFieldToStream private function @ignore
Message::serializeSingularFieldToStream private function @ignore
Message::serializeToJsonStream public function @ignore
Message::serializeToJsonString public function Serialize the message to json string.
Message::serializeToStream public function @ignore
Message::serializeToString public function Serialize the message to string.
Message::skipField private function @ignore
Message::whichOneof protected function
Message::writeOneof protected function
Message::writeWrapperValue protected function
Message::__debugInfo public function
SummaryDataPoint::$attributes private property The set of key/value pairs that uniquely identify the timeseries from
where this point belongs. The list may be empty (may contain 0 elements).
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
SummaryDataPoint::$count protected property count is the number of values in the population. Must be non-negative.
SummaryDataPoint::$flags protected property Flags that apply to this specific data point. See DataPointFlags
for the available flags and their meaning.
SummaryDataPoint::$quantile_values private property (Optional) list of values at different quantiles of the distribution calculated
from the current snapshot. The quantiles must be strictly increasing.
SummaryDataPoint::$start_time_unix_nano protected property StartTimeUnixNano is optional but strongly encouraged, see the
the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::$sum protected property sum of the values in the population. If count is zero then this field
must be zero.
Note: Sum should only be filled out when measuring non-negative discrete
events, and is assumed to be monotonic over the values of these events.
Negative events *can*…
SummaryDataPoint::$time_unix_nano protected property TimeUnixNano is required, see the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::getAttributes public function The set of key/value pairs that uniquely identify the timeseries from
where this point belongs. The list may be empty (may contain 0 elements).
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
SummaryDataPoint::getCount public function count is the number of values in the population. Must be non-negative.
SummaryDataPoint::getFlags public function Flags that apply to this specific data point. See DataPointFlags
for the available flags and their meaning.
SummaryDataPoint::getQuantileValues public function (Optional) list of values at different quantiles of the distribution calculated
from the current snapshot. The quantiles must be strictly increasing.
SummaryDataPoint::getStartTimeUnixNano public function StartTimeUnixNano is optional but strongly encouraged, see the
the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::getSum public function sum of the values in the population. If count is zero then this field
must be zero.
Note: Sum should only be filled out when measuring non-negative discrete
events, and is assumed to be monotonic over the values of these events.
Negative events *can*…
SummaryDataPoint::getTimeUnixNano public function TimeUnixNano is required, see the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::setAttributes public function The set of key/value pairs that uniquely identify the timeseries from
where this point belongs. The list may be empty (may contain 0 elements).
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
SummaryDataPoint::setCount public function count is the number of values in the population. Must be non-negative.
SummaryDataPoint::setFlags public function Flags that apply to this specific data point. See DataPointFlags
for the available flags and their meaning.
SummaryDataPoint::setQuantileValues public function (Optional) list of values at different quantiles of the distribution calculated
from the current snapshot. The quantiles must be strictly increasing.
SummaryDataPoint::setStartTimeUnixNano public function StartTimeUnixNano is optional but strongly encouraged, see the
the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::setSum public function sum of the values in the population. If count is zero then this field
must be zero.
Note: Sum should only be filled out when measuring non-negative discrete
events, and is assumed to be monotonic over the values of these events.
Negative events *can*…
SummaryDataPoint::setTimeUnixNano public function TimeUnixNano is required, see the detailed comments above Metric.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
SummaryDataPoint::__construct public function Constructor. Overrides Message::__construct
RSS feed
Powered by Drupal