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

Breadcrumb

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

class Event

Same name in this branch
  1. 11.1.x vendor/open-telemetry/sdk/Trace/Event.php \OpenTelemetry\SDK\Trace\Event
  2. 11.1.x vendor/composer/composer/src/Composer/Script/Event.php \Composer\Script\Event
  3. 11.1.x vendor/composer/composer/src/Composer/EventDispatcher/Event.php \Composer\EventDispatcher\Event
  4. 11.1.x vendor/symfony/event-dispatcher-contracts/Event.php \Symfony\Contracts\EventDispatcher\Event
  5. 11.1.x core/lib/Drupal/Component/EventDispatcher/Event.php \Drupal\Component\EventDispatcher\Event

Event is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs.

Generated from protobuf message <code>opentelemetry.proto.trace.v1.Span.Event</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Opentelemetry\Proto\Trace\V1\Span\Event extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of Event

1 file declares its use of Event
SpanConverter.php in vendor/open-telemetry/exporter-otlp/SpanConverter.php
3 string references to 'Event'
DatabaseBackend::schemaDefinition in core/lib/Drupal/Core/Flood/DatabaseBackend.php
Defines the schema for the flood table.
EventDriver::isSupported in vendor/revolt/event-loop/src/EventLoop/Driver/EventDriver.php
PerformanceTestRecorder::onRouteBuilderFinish in core/lib/Drupal/Core/Test/PerformanceTestRecorder.php
Records a router rebuild.

File

vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Trace/V1/Span/Event.php, line 17

Namespace

Opentelemetry\Proto\Trace\V1\Span
View source
class Event extends \Google\Protobuf\Internal\Message {
    
    /**
     * time_unix_nano is the time the event occurred.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 1;</code>
     */
    protected $time_unix_nano = 0;
    
    /**
     * name of the event.
     * This field is semantically required to be set to non-empty string.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     */
    protected $name = '';
    
    /**
     * attributes is a collection of attribute key/value pairs on the event.
     * 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 = 3;</code>
     */
    private $attributes;
    
    /**
     * dropped_attributes_count is the number of dropped attributes. If the value is 0,
     * then no attributes were dropped.
     *
     * Generated from protobuf field <code>uint32 dropped_attributes_count = 4;</code>
     */
    protected $dropped_attributes_count = 0;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int|string $time_unix_nano
     *           time_unix_nano is the time the event occurred.
     *     @type string $name
     *           name of the event.
     *           This field is semantically required to be set to non-empty string.
     *     @type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
     *           attributes is a collection of attribute key/value pairs on the event.
     *           Attribute keys MUST be unique (it is not allowed to have more than one
     *           attribute with the same key).
     *     @type int $dropped_attributes_count
     *           dropped_attributes_count is the number of dropped attributes. If the value is 0,
     *           then no attributes were dropped.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Opentelemetry\Proto\Trace\V1\Trace::initOnce();
        parent::__construct($data);
    }
    
    /**
     * time_unix_nano is the time the event occurred.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 1;</code>
     * @return int|string
     */
    public function getTimeUnixNano() {
        return $this->time_unix_nano;
    }
    
    /**
     * time_unix_nano is the time the event occurred.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 1;</code>
     * @param int|string $var
     * @return $this
     */
    public function setTimeUnixNano($var) {
        GPBUtil::checkUint64($var);
        $this->time_unix_nano = $var;
        return $this;
    }
    
    /**
     * name of the event.
     * This field is semantically required to be set to non-empty string.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     * @return string
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * name of the event.
     * This field is semantically required to be set to non-empty string.
     *
     * Generated from protobuf field <code>string name = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var) {
        GPBUtil::checkString($var, True);
        $this->name = $var;
        return $this;
    }
    
    /**
     * attributes is a collection of attribute key/value pairs on the event.
     * 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 = 3;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getAttributes() {
        return $this->attributes;
    }
    
    /**
     * attributes is a collection of attribute key/value pairs on the event.
     * 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 = 3;</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;
    }
    
    /**
     * dropped_attributes_count is the number of dropped attributes. If the value is 0,
     * then no attributes were dropped.
     *
     * Generated from protobuf field <code>uint32 dropped_attributes_count = 4;</code>
     * @return int
     */
    public function getDroppedAttributesCount() {
        return $this->dropped_attributes_count;
    }
    
    /**
     * dropped_attributes_count is the number of dropped attributes. If the value is 0,
     * then no attributes were dropped.
     *
     * Generated from protobuf field <code>uint32 dropped_attributes_count = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setDroppedAttributesCount($var) {
        GPBUtil::checkUint32($var);
        $this->dropped_attributes_count = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Event::$attributes private property attributes is a collection of attribute key/value pairs on the event.
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
Event::$dropped_attributes_count protected property dropped_attributes_count is the number of dropped attributes. If the value is 0,
then no attributes were dropped.
Event::$name protected property name of the event.
This field is semantically required to be set to non-empty string.
Event::$time_unix_nano protected property time_unix_nano is the time the event occurred.
Event::getAttributes public function attributes is a collection of attribute key/value pairs on the event.
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
Event::getDroppedAttributesCount public function dropped_attributes_count is the number of dropped attributes. If the value is 0,
then no attributes were dropped.
Event::getName public function name of the event.
This field is semantically required to be set to non-empty string.
Event::getTimeUnixNano public function time_unix_nano is the time the event occurred.
Event::setAttributes public function attributes is a collection of attribute key/value pairs on the event.
Attribute keys MUST be unique (it is not allowed to have more than one
attribute with the same key).
Event::setDroppedAttributesCount public function dropped_attributes_count is the number of dropped attributes. If the value is 0,
then no attributes were dropped.
Event::setName public function name of the event.
This field is semantically required to be set to non-empty string.
Event::setTimeUnixNano public function time_unix_nano is the time the event occurred.
Event::__construct public function Constructor. Overrides Message::__construct
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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal