PHPFUI/InstaDoc

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly.

BucketOptions does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

Generated from protobuf message google.api.Distribution.BucketOptions

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type \Google\Api\Distribution\BucketOptions\Linear $linear_buckets
      The linear bucket.
@type \Google\Api\Distribution\BucketOptions\Exponential $exponential_buckets
      The exponential buckets.
@type \Google\Api\Distribution\BucketOptions\Explicit $explicit_buckets
      The explicit buckets.

}

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 Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getExplicitBuckets()

The explicit buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

return \Google\Api\Distribution\BucketOptions\Explicit|null

public getExponentialBuckets()

The exponential buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

return \Google\Api\Distribution\BucketOptions\Exponential|null

public getLinearBuckets()

The linear bucket.

Generated from protobuf field .google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

return \Google\Api\Distribution\BucketOptions\Linear|null

public getOptions()

return string

public hasExplicitBuckets()

public hasExponentialBuckets()

public hasLinearBuckets()

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

The explicit buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

param \Google\Api\Distribution\BucketOptions\Explicit $var
return $this

public setExponentialBuckets( $var)

The exponential buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

param \Google\Api\Distribution\BucketOptions\Exponential $var
return $this

public setLinearBuckets( $var)

The linear bucket.

Generated from protobuf field .google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

param \Google\Api\Distribution\BucketOptions\Linear $var
return $this

Properties

protected $options = NULL

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)

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only