PHPFUI/InstaDoc
 
Copied!

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param 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 array<\Google\Protobuf\Any>|\Google\Protobuf\Internal\RepeatedField $attachments
      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.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearTimestamp()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public 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.

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

  • return \Google\Protobuf\Internal\RepeatedField
public getTimestamp()
 

The observation (sampling) time of the above value.

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

  • return \Google\Protobuf\Timestamp|null
public getValue()
 

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

Generated from protobuf field double value = 1;

  • return float
public hasTimestamp()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setAttachments( $var)
 

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.

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

  • param \Google\Protobuf\Any[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setTimestamp( $var)
 

The observation (sampling) time of the above value.

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

  • param \Google\Protobuf\Timestamp $var
  • return $this
public setValue( $var)
 

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

Generated from protobuf field double value = 1;

  • param float $var
  • return $this
Properties
protected $timestamp = NULL
 

The observation (sampling) time of the above value.

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

protected $value = 0
 

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

Generated from protobuf field double value = 1;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $attachments = NULL
 

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.

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

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration