package distribution

Import Path
	google.golang.org/genproto/googleapis/api/distribution (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	      distribution.pb.go
Package-Level Type Names (total 11, in which 10 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Distribution (struct)
		`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.

		Fields (total 10, in which 7 are exported)
			BucketCounts []int64
				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).

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

			Count int64
				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.

			Exemplars []*Distribution_Exemplar
				Must be in increasing order of `value` field.

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

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

			SumOfSquaredDeviation float64
				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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 12, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution.ProtoReflect.Descriptor instead.

			(*T) GetBucketCounts() []int64
			(*T) GetBucketOptions() *Distribution_BucketOptions
			(*T) GetCount() int64
			(*T) GetExemplars() []*Distribution_Exemplar
			(*T) GetMean() float64
			(*T) GetRange() *Distribution_Range
			(*T) GetSumOfSquaredDeviation() float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TypedValue).GetDistributionValue() *Distribution

	 type Distribution_BucketOptions (struct)
		`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.

		Fields (total 4, in which 1 are exported)
			Options isDistribution_BucketOptions_Options
				Exactly one of these three fields must be set.

				Types that are assignable to Options:
					*Distribution_BucketOptions_LinearBuckets
					*Distribution_BucketOptions_ExponentialBuckets
					*Distribution_BucketOptions_ExplicitBuckets

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 9, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_BucketOptions.ProtoReflect.Descriptor instead.

			(*T) GetExplicitBuckets() *Distribution_BucketOptions_Explicit
			(*T) GetExponentialBuckets() *Distribution_BucketOptions_Exponential
			(*T) GetLinearBuckets() *Distribution_BucketOptions_Linear
			(*T) GetOptions() isDistribution_BucketOptions_Options
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 2, both are exported)
			func (*Distribution).GetBucketOptions() *Distribution_BucketOptions
			func google.golang.org/genproto/googleapis/logging/v2.(*LogMetric).GetBucketOptions() *Distribution_BucketOptions

	 type Distribution_BucketOptions_Explicit (struct)
		Specifies a set of buckets with arbitrary widths.

		There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
		boundaries:

		   Upper bound (0 <= i < N-1):     bounds[i]
		   Lower bound (1 <= i < N);       bounds[i - 1]

		The `bounds` field must contain at least one element. If `bounds` has
		only one element, then there are no finite buckets, and that single
		element is the common boundary of the overflow and underflow buckets.

		Fields (total 4, in which 1 are exported)
			Bounds []float64
				The values must be monotonically increasing.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_BucketOptions_Explicit.ProtoReflect.Descriptor instead.

			(*T) GetBounds() []float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Distribution_BucketOptions).GetExplicitBuckets() *Distribution_BucketOptions_Explicit

	 type Distribution_BucketOptions_ExplicitBuckets (struct)

		Fields (only one, which is exported)
			ExplicitBuckets *Distribution_BucketOptions_Explicit
				The explicit buckets.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) isDistribution_BucketOptions_Options()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : isDistribution_BucketOptions_Options

	 type Distribution_BucketOptions_Exponential (struct)
		Specifies an exponential sequence of buckets that have a width that is
		proportional to the value of the lower bound. Each bucket represents a
		constant relative uncertainty on a specific value in the bucket.

		There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
		following boundaries:

		   Upper bound (0 <= i < N-1):     scale * (growth_factor ^ i).
		   Lower bound (1 <= i < N):       scale * (growth_factor ^ (i - 1)).

		Fields (total 6, in which 3 are exported)
			GrowthFactor float64
				Must be greater than 1.

			NumFiniteBuckets int32
				Must be greater than 0.

			Scale float64
				Must be greater than 0.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_BucketOptions_Exponential.ProtoReflect.Descriptor instead.

			(*T) GetGrowthFactor() float64
			(*T) GetNumFiniteBuckets() int32
			(*T) GetScale() float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Distribution_BucketOptions).GetExponentialBuckets() *Distribution_BucketOptions_Exponential

	 type Distribution_BucketOptions_ExponentialBuckets (struct)

		Fields (only one, which is exported)
			ExponentialBuckets *Distribution_BucketOptions_Exponential
				The exponential buckets.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) isDistribution_BucketOptions_Options()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : isDistribution_BucketOptions_Options

	 type Distribution_BucketOptions_Linear (struct)
		Specifies a linear sequence of buckets that all have the same width
		(except overflow and underflow). Each bucket represents a constant
		absolute uncertainty on the specific value in the bucket.

		There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
		following boundaries:

		   Upper bound (0 <= i < N-1):     offset + (width * i).
		   Lower bound (1 <= i < N):       offset + (width * (i - 1)).

		Fields (total 6, in which 3 are exported)
			NumFiniteBuckets int32
				Must be greater than 0.

			Offset float64
				Lower bound of the first bucket.

			Width float64
				Must be greater than 0.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_BucketOptions_Linear.ProtoReflect.Descriptor instead.

			(*T) GetNumFiniteBuckets() int32
			(*T) GetOffset() float64
			(*T) GetWidth() float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Distribution_BucketOptions).GetLinearBuckets() *Distribution_BucketOptions_Linear

	 type Distribution_BucketOptions_LinearBuckets (struct)

		Fields (only one, which is exported)
			LinearBuckets *Distribution_BucketOptions_Linear
				The linear bucket.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) isDistribution_BucketOptions_Options()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : isDistribution_BucketOptions_Options

	 type Distribution_Exemplar (struct)
		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.

		Fields (total 6, in which 3 are exported)
			Attachments []*anypb.Any
				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.

			Timestamp *timestamppb.Timestamp
				The observation (sampling) time of the above value.

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

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_Exemplar.ProtoReflect.Descriptor instead.

			(*T) GetAttachments() []*anypb.Any
			(*T) GetTimestamp() *timestamppb.Timestamp
			(*T) GetValue() float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 3, in which 1 are exported)
			func (*Distribution).GetExemplars() []*Distribution_Exemplar
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func contrib.go.opencensus.io/exporter/stackdriver.metricBucketToBucketCountsAndExemplars(buckets []metricdata.Bucket, projectID string) ([]int64, []*Distribution_Exemplar)
			func contrib.go.opencensus.io/exporter/stackdriver.metricExemplarToPbExemplar(exemplar *metricdata.Exemplar, projectID string) *Distribution_Exemplar

	 type Distribution_Range (struct)
		The range of the population values.

		Fields (total 5, in which 2 are exported)
			Max float64
				The maximum of the population values.

			Min float64
				The minimum of the population values.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Distribution_Range.ProtoReflect.Descriptor instead.

			(*T) GetMax() float64
			(*T) GetMin() float64
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Distribution).GetRange() *Distribution_Range

	/* one unexported ... *//* one unexported: */
	 type isDistribution_BucketOptions_Options (interface)

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( T) isDistribution_BucketOptions_Options()
		Implemented By (at least 3, all are exported)
			*Distribution_BucketOptions_ExplicitBuckets
			*Distribution_BucketOptions_ExponentialBuckets
			*Distribution_BucketOptions_LinearBuckets
		As Outputs Of (at least one exported)
			func (*Distribution_BucketOptions).GetOptions() isDistribution_BucketOptions_Options


Package-Level Functions (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func file_google_api_distribution_proto_init()
	 func file_google_api_distribution_proto_rawDescGZIP() []byte
	 func init()
Package-Level Variables (total 7, in which 1 are exported)

	  var File_google_api_distribution_proto protoreflect.FileDescriptor
	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var file_google_api_distribution_proto_depIdxs []int32
	  var file_google_api_distribution_proto_goTypes []interface{}
	  var file_google_api_distribution_proto_msgTypes []impl.MessageInfo
	  var file_google_api_distribution_proto_rawDesc []byte
	  var file_google_api_distribution_proto_rawDescData []byte
	  var file_google_api_distribution_proto_rawDescOnce sync.Once

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.