Distribution contains summary statistics for a population of values. It
optionally contains a histogram representing the distribution of those values
across a set of buckets.

The summary statistics are the count, mean, sum of the squared deviation from
the mean, the minimum, and the maximum of the set of population of values.
The histogram is based on a sequence of buckets and gives a count of values
that fall into each bucket. The boundaries of the buckets are given either
explicitly or by formulas for buckets of fixed or exponentially increasing
widths.
Although it is not forbidden, it is generally a bad idea to include
non-finite values (infinities or NaNs) in the population of values, as this
will render the mean and sum_of_squared_deviation fields meaningless.

Generated from protobuf message google.api.Distribution

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

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

    Clear all unknown fields previously parsed.

    • return
    public getBucketCounts()
     

    The number of values in each bucket of the histogram, as described in
    bucket_options. If the distribution does not have a histogram, then omit
    this field. If there is a histogram, then the sum of the values in
    bucket_counts must equal the value in the count field of the
    distribution.

    If present, bucket_counts should contain N values, where N is the number
    of buckets specified in bucket_options. If you supply fewer than N
    values, the remaining values are assumed to be 0.
    The order of the values in bucket_counts follows the bucket numbering
    schemes described for the three bucket types. The first value must be the
    count for the underflow bucket (number 0). The next N-2 values are the
    counts for the finite buckets (number 1 through N-2). The N'th value in
    bucket_counts is the count for the overflow bucket (number N-1).

    Generated from protobuf field repeated int64 bucket_counts = 7;

    public getBucketOptions()
     

    Defines the histogram bucket boundaries. If the distribution does not
    contain a histogram, then omit this field.

    Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;

    public getCount()
     

    The number of values in the population. Must be non-negative. This value
    must equal the sum of the values in bucket_counts if a histogram is
    provided.

    Generated from protobuf field int64 count = 1;

    • return int|string
    public getExemplars()
     

    Must be in increasing order of value field.

    Generated from protobuf field repeated .google.api.Distribution.Exemplar exemplars = 10;

    public getMean()
     

    The arithmetic mean of the values in the population. If count is zero
    then this field must be zero.

    Generated from protobuf field double mean = 2;

    • return float
    public getRange()
     

    If specified, contains the range of the population values. The field
    must not be present if the count is zero.

    Generated from protobuf field .google.api.Distribution.Range range = 4;

    public getSumOfSquaredDeviation()
     

    The sum of squared deviations from the mean of the values in the
    population. For values x_i this is:

    Sum[i=1..n]((x_i - mean)^2)
    

    Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
    describes Welford's method for accumulating this sum in one pass.

    If count is zero then this field must be zero.

    Generated from protobuf field double sum_of_squared_deviation = 3;

    • return float
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • 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.

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

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

    • return
    • 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()
     

    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 setBucketCounts( $var)
     

    The number of values in each bucket of the histogram, as described in
    bucket_options. If the distribution does not have a histogram, then omit
    this field. If there is a histogram, then the sum of the values in
    bucket_counts must equal the value in the count field of the
    distribution.

    If present, bucket_counts should contain N values, where N is the number
    of buckets specified in bucket_options. If you supply fewer than N
    values, the remaining values are assumed to be 0.
    The order of the values in bucket_counts follows the bucket numbering
    schemes described for the three bucket types. The first value must be the
    count for the underflow bucket (number 0). The next N-2 values are the
    counts for the finite buckets (number 1 through N-2). The N'th value in
    bucket_counts is the count for the overflow bucket (number N-1).

    Generated from protobuf field repeated int64 bucket_counts = 7;

    • return $this
    public setBucketOptions( $var)
     

    Defines the histogram bucket boundaries. If the distribution does not
    contain a histogram, then omit this field.

    Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;

    • return $this
    public setCount( $var)
     

    The number of values in the population. Must be non-negative. This value
    must equal the sum of the values in bucket_counts if a histogram is
    provided.

    Generated from protobuf field int64 count = 1;

    • return $this
    public setExemplars( $var)
     

    Must be in increasing order of value field.

    Generated from protobuf field repeated .google.api.Distribution.Exemplar exemplars = 10;

    • return $this
    public setMean( $var)
     

    The arithmetic mean of the values in the population. If count is zero
    then this field must be zero.

    Generated from protobuf field double mean = 2;

    • return $this
    public setRange( $var)
     

    If specified, contains the range of the population values. The field
    must not be present if the count is zero.

    Generated from protobuf field .google.api.Distribution.Range range = 4;

    • return $this
    public setSumOfSquaredDeviation( $var)
     

    The sum of squared deviations from the mean of the values in the
    population. For values x_i this is:

    Sum[i=1..n]((x_i - mean)^2)
    

    Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
    describes Welford's method for accumulating this sum in one pass.

    If count is zero then this field must be zero.

    Generated from protobuf field double sum_of_squared_deviation = 3;

    • return $this
    Methods
    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.

    • return
    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 $bucket_counts
     

    The number of values in each bucket of the histogram, as described in
    bucket_options. If the distribution does not have a histogram, then omit
    this field. If there is a histogram, then the sum of the values in
    bucket_counts must equal the value in the count field of the
    distribution.

    If present, bucket_counts should contain N values, where N is the number
    of buckets specified in bucket_options. If you supply fewer than N
    values, the remaining values are assumed to be 0.
    The order of the values in bucket_counts follows the bucket numbering
    schemes described for the three bucket types. The first value must be the
    count for the underflow bucket (number 0). The next N-2 values are the
    counts for the finite buckets (number 1 through N-2). The N'th value in
    bucket_counts is the count for the overflow bucket (number N-1).

    Generated from protobuf field repeated int64 bucket_counts = 7;

    private $bucket_options
     

    Defines the histogram bucket boundaries. If the distribution does not
    contain a histogram, then omit this field.

    Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;

    private $count
     

    The number of values in the population. Must be non-negative. This value
    must equal the sum of the values in bucket_counts if a histogram is
    provided.

    Generated from protobuf field int64 count = 1;

    private $exemplars
     

    Must be in increasing order of value field.

    Generated from protobuf field repeated .google.api.Distribution.Exemplar exemplars = 10;

    private $mean
     

    The arithmetic mean of the values in the population. If count is zero
    then this field must be zero.

    Generated from protobuf field double mean = 2;

    private $range
     

    If specified, contains the range of the population values. The field
    must not be present if the count is zero.

    Generated from protobuf field .google.api.Distribution.Range range = 4;

    private $sum_of_squared_deviation
     

    The sum of squared deviations from the mean of the values in the
    population. For values x_i this is:

    Sum[i=1..n]((x_i - mean)^2)
    

    Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
    describes Welford's method for accumulating this sum in one pass.

    If count is zero then this field must be zero.

    Generated from protobuf field double sum_of_squared_deviation = 3;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    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 each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      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.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        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 each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          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.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only