Distribution represents a frequency distribution of double-valued sample
points. It contains the size of the population of sample points plus
additional optional information:

  • the arithmetic mean of the samples
  • the minimum and maximum of the samples
  • the sum-squared-deviation of the samples, used to compute variance
  • a histogram of the values of the sample points

Generated from protobuf message google.api.servicecontrol.v1.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 samples in each histogram bucket. bucket_counts are
    optional. If present, they must sum to the count value.

    The buckets are defined below in bucket_option. There are N buckets.
    bucket_counts[0] is the number of samples in the underflow bucket.
    bucket_counts[1] to bucket_counts[N-1] are the numbers of samples
    in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option`
    below for more details.
    Any suffix of trailing zeros may be omitted.

    Generated from protobuf field repeated int64 bucket_counts = 6;

    public getBucketOption()
     
    • return string
    public getCount()
     

    The total number of samples in the distribution. Must be >= 0.

    Generated from protobuf field int64 count = 1;

    • return int|string
    public getExplicitBuckets()
     

    Buckets with arbitrary user-provided width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;

    public getExponentialBuckets()
     

    Buckets with exponentially growing width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;

    public getLinearBuckets()
     

    Buckets with constant width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;

    public getMaximum()
     

    The maximum of the population of values. Ignored if count is zero.

    Generated from protobuf field double maximum = 4;

    • return float
    public getMean()
     

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

    Generated from protobuf field double mean = 2;

    • return float
    public getMinimum()
     

    The minimum of the population of values. Ignored if count is zero.

    Generated from protobuf field double minimum = 3;

    • return float
    public getSumOfSquaredDeviation()
     

    The sum of squared deviations from the mean:
    Sum[i=1..count]((x_i - mean)^2)
    where each x_i is a sample values. If count is zero then this field
    must be zero, otherwise validation of the request fails.

    Generated from protobuf field double sum_of_squared_deviation = 5;

    • 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 samples in each histogram bucket. bucket_counts are
    optional. If present, they must sum to the count value.

    The buckets are defined below in bucket_option. There are N buckets.
    bucket_counts[0] is the number of samples in the underflow bucket.
    bucket_counts[1] to bucket_counts[N-1] are the numbers of samples
    in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option`
    below for more details.
    Any suffix of trailing zeros may be omitted.

    Generated from protobuf field repeated int64 bucket_counts = 6;

    • return $this
    public setCount( $var)
     

    The total number of samples in the distribution. Must be >= 0.

    Generated from protobuf field int64 count = 1;

    • return $this
    public setExplicitBuckets( $var)
     

    Buckets with arbitrary user-provided width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;

    • return $this
    public setExponentialBuckets( $var)
     

    Buckets with exponentially growing width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;

    • return $this
    public setLinearBuckets( $var)
     

    Buckets with constant width.

    Generated from protobuf field .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;

    • return $this
    public setMaximum( $var)
     

    The maximum of the population of values. Ignored if count is zero.

    Generated from protobuf field double maximum = 4;

    • return $this
    public setMean( $var)
     

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

    Generated from protobuf field double mean = 2;

    • return $this
    public setMinimum( $var)
     

    The minimum of the population of values. Ignored if count is zero.

    Generated from protobuf field double minimum = 3;

    • return $this
    public setSumOfSquaredDeviation( $var)
     

    The sum of squared deviations from the mean:
    Sum[i=1..count]((x_i - mean)^2)
    where each x_i is a sample values. If count is zero then this field
    must be zero, otherwise validation of the request fails.

    Generated from protobuf field double sum_of_squared_deviation = 5;

    • return $this
    Properties
    protected $bucket_option
    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 samples in each histogram bucket. bucket_counts are
    optional. If present, they must sum to the count value.

    The buckets are defined below in bucket_option. There are N buckets.
    bucket_counts[0] is the number of samples in the underflow bucket.
    bucket_counts[1] to bucket_counts[N-1] are the numbers of samples
    in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option`
    below for more details.
    Any suffix of trailing zeros may be omitted.

    Generated from protobuf field repeated int64 bucket_counts = 6;

    private $count
     

    The total number of samples in the distribution. Must be >= 0.

    Generated from protobuf field int64 count = 1;

    private $maximum
     

    The maximum of the population of values. Ignored if count is zero.

    Generated from protobuf field double maximum = 4;

    private $mean
     

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

    Generated from protobuf field double mean = 2;

    private $minimum
     

    The minimum of the population of values. Ignored if count is zero.

    Generated from protobuf field double minimum = 3;

    private $sum_of_squared_deviation
     

    The sum of squared deviations from the mean:
    Sum[i=1..count]((x_i - mean)^2)
    where each x_i is a sample values. If count is zero then this field
    must be zero, otherwise validation of the request fails.

    Generated from protobuf field double sum_of_squared_deviation = 5;

    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