Link.php

<?php


# Generated by the protocol buffer compiler.  DO NOT EDIT!

# source: opentelemetry/proto/trace/v1/trace.proto
namespace Opentelemetry\Proto\Trace\V1\Span;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * A pointer from the current span to another span in the same trace or in a
 * different trace. For example, this can be used in batching operations,
 * where a single batch handler processes multiple requests from different
 * traces or when the handler receives a request from a different project.
 *
 * Generated from protobuf message <code>opentelemetry.proto.trace.v1.Span.Link</code>
 */
class Link extends \Google\Protobuf\Internal\Message {
    
    /**
     * A unique identifier of a trace that this linked span is part of. The ID is a
     * 16-byte array.
     *
     * Generated from protobuf field <code>bytes trace_id = 1;</code>
     */
    protected $trace_id = '';
    
    /**
     * A unique identifier for the linked span. The ID is an 8-byte array.
     *
     * Generated from protobuf field <code>bytes span_id = 2;</code>
     */
    protected $span_id = '';
    
    /**
     * The trace_state associated with the link.
     *
     * Generated from protobuf field <code>string trace_state = 3;</code>
     */
    protected $trace_state = '';
    
    /**
     * attributes is a collection of attribute key/value pairs on the link.
     * 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 = 4;</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 = 5;</code>
     */
    protected $dropped_attributes_count = 0;
    
    /**
     * Flags, a bit field.
     * Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
     * Context specification. To read the 8-bit W3C trace flag, use
     * `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
     * See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
     * Bits 8 and 9 represent the 3 states of whether the link is remote.
     * The states are (unknown, is not remote, is remote).
     * To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
     * To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
     * Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
     * When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.
     * [Optional].
     *
     * Generated from protobuf field <code>fixed32 flags = 6;</code>
     */
    protected $flags = 0;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $trace_id
     *           A unique identifier of a trace that this linked span is part of. The ID is a
     *           16-byte array.
     *     @type string $span_id
     *           A unique identifier for the linked span. The ID is an 8-byte array.
     *     @type string $trace_state
     *           The trace_state associated with the link.
     *     @type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
     *           attributes is a collection of attribute key/value pairs on the link.
     *           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.
     *     @type int $flags
     *           Flags, a bit field.
     *           Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
     *           Context specification. To read the 8-bit W3C trace flag, use
     *           `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
     *           See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
     *           Bits 8 and 9 represent the 3 states of whether the link is remote.
     *           The states are (unknown, is not remote, is remote).
     *           To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
     *           To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
     *           Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
     *           When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.
     *           [Optional].
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Opentelemetry\Proto\Trace\V1\Trace::initOnce();
        parent::__construct($data);
    }
    
    /**
     * A unique identifier of a trace that this linked span is part of. The ID is a
     * 16-byte array.
     *
     * Generated from protobuf field <code>bytes trace_id = 1;</code>
     * @return string
     */
    public function getTraceId() {
        return $this->trace_id;
    }
    
    /**
     * A unique identifier of a trace that this linked span is part of. The ID is a
     * 16-byte array.
     *
     * Generated from protobuf field <code>bytes trace_id = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setTraceId($var) {
        GPBUtil::checkString($var, False);
        $this->trace_id = $var;
        return $this;
    }
    
    /**
     * A unique identifier for the linked span. The ID is an 8-byte array.
     *
     * Generated from protobuf field <code>bytes span_id = 2;</code>
     * @return string
     */
    public function getSpanId() {
        return $this->span_id;
    }
    
    /**
     * A unique identifier for the linked span. The ID is an 8-byte array.
     *
     * Generated from protobuf field <code>bytes span_id = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setSpanId($var) {
        GPBUtil::checkString($var, False);
        $this->span_id = $var;
        return $this;
    }
    
    /**
     * The trace_state associated with the link.
     *
     * Generated from protobuf field <code>string trace_state = 3;</code>
     * @return string
     */
    public function getTraceState() {
        return $this->trace_state;
    }
    
    /**
     * The trace_state associated with the link.
     *
     * Generated from protobuf field <code>string trace_state = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setTraceState($var) {
        GPBUtil::checkString($var, True);
        $this->trace_state = $var;
        return $this;
    }
    
    /**
     * attributes is a collection of attribute key/value pairs on the link.
     * 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 = 4;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getAttributes() {
        return $this->attributes;
    }
    
    /**
     * attributes is a collection of attribute key/value pairs on the link.
     * 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 = 4;</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 = 5;</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 = 5;</code>
     * @param int $var
     * @return $this
     */
    public function setDroppedAttributesCount($var) {
        GPBUtil::checkUint32($var);
        $this->dropped_attributes_count = $var;
        return $this;
    }
    
    /**
     * Flags, a bit field.
     * Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
     * Context specification. To read the 8-bit W3C trace flag, use
     * `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
     * See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
     * Bits 8 and 9 represent the 3 states of whether the link is remote.
     * The states are (unknown, is not remote, is remote).
     * To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
     * To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
     * Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
     * When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.
     * [Optional].
     *
     * Generated from protobuf field <code>fixed32 flags = 6;</code>
     * @return int
     */
    public function getFlags() {
        return $this->flags;
    }
    
    /**
     * Flags, a bit field.
     * Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
     * Context specification. To read the 8-bit W3C trace flag, use
     * `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
     * See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
     * Bits 8 and 9 represent the 3 states of whether the link is remote.
     * The states are (unknown, is not remote, is remote).
     * To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
     * To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
     * Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
     * When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.
     * [Optional].
     *
     * Generated from protobuf field <code>fixed32 flags = 6;</code>
     * @param int $var
     * @return $this
     */
    public function setFlags($var) {
        GPBUtil::checkUint32($var);
        $this->flags = $var;
        return $this;
    }

}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Link::class, \Opentelemetry\Proto\Trace\V1\Span_Link::class);