google-cloud-monitoring-dashboard-v1 0.6.5 → 0.8.0

data/proto_docs/google/api/distribution.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
-
-
-module Google
-  module Api
-    # `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.
-    # @!attribute [rw] count
-    #   @return [::Integer]
-    #     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.
-    # @!attribute [rw] mean
-    #   @return [::Float]
-    #     The arithmetic mean of the values in the population. If `count` is zero
-    #     then this field must be zero.
-    # @!attribute [rw] sum_of_squared_deviation
-    #   @return [::Float]
-    #     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 232, 3rd edition
-    #     describes Welford's method for accumulating this sum in one pass.
-    #
-    #     If `count` is zero then this field must be zero.
-    # @!attribute [rw] range
-    #   @return [::Google::Api::Distribution::Range]
-    #     If specified, contains the range of the population values. The field
-    #     must not be present if the `count` is zero.
-    # @!attribute [rw] bucket_options
-    #   @return [::Google::Api::Distribution::BucketOptions]
-    #     Defines the histogram bucket boundaries. If the distribution does not
-    #     contain a histogram, then omit this field.
-    # @!attribute [rw] bucket_counts
-    #   @return [::Array<::Integer>]
-    #     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).
-    # @!attribute [rw] exemplars
-    #   @return [::Array<::Google::Api::Distribution::Exemplar>]
-    #     Must be in increasing order of `value` field.
-    class Distribution
-      include ::Google::Protobuf::MessageExts
-      extend ::Google::Protobuf::MessageExts::ClassMethods
-
-      # The range of the population values.
-      # @!attribute [rw] min
-      #   @return [::Float]
-      #     The minimum of the population values.
-      # @!attribute [rw] max
-      #   @return [::Float]
-      #     The maximum of the population values.
-      class Range
-        include ::Google::Protobuf::MessageExts
-        extend ::Google::Protobuf::MessageExts::ClassMethods
-      end
-
-      # `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.
-      # @!attribute [rw] linear_buckets
-      #   @return [::Google::Api::Distribution::BucketOptions::Linear]
-      #     The linear bucket.
-      # @!attribute [rw] exponential_buckets
-      #   @return [::Google::Api::Distribution::BucketOptions::Exponential]
-      #     The exponential buckets.
-      # @!attribute [rw] explicit_buckets
-      #   @return [::Google::Api::Distribution::BucketOptions::Explicit]
-      #     The explicit buckets.
-      class BucketOptions
-        include ::Google::Protobuf::MessageExts
-        extend ::Google::Protobuf::MessageExts::ClassMethods
-
-        # 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)).
-        # @!attribute [rw] num_finite_buckets
-        #   @return [::Integer]
-        #     Must be greater than 0.
-        # @!attribute [rw] width
-        #   @return [::Float]
-        #     Must be greater than 0.
-        # @!attribute [rw] offset
-        #   @return [::Float]
-        #     Lower bound of the first bucket.
-        class Linear
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # 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)).
-        # @!attribute [rw] num_finite_buckets
-        #   @return [::Integer]
-        #     Must be greater than 0.
-        # @!attribute [rw] growth_factor
-        #   @return [::Float]
-        #     Must be greater than 1.
-        # @!attribute [rw] scale
-        #   @return [::Float]
-        #     Must be greater than 0.
-        class Exponential
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # 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.
-        # @!attribute [rw] bounds
-        #   @return [::Array<::Float>]
-        #     The values must be monotonically increasing.
-        class Explicit
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-      end
-
-      # 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.
-      # @!attribute [rw] value
-      #   @return [::Float]
-      #     Value of the exemplar point. This value determines to which bucket the
-      #     exemplar belongs.
-      # @!attribute [rw] timestamp
-      #   @return [::Google::Protobuf::Timestamp]
-      #     The observation (sampling) time of the above value.
-      # @!attribute [rw] attachments
-      #   @return [::Array<::Google::Protobuf::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.
-      class Exemplar
-        include ::Google::Protobuf::MessageExts
-        extend ::Google::Protobuf::MessageExts::ClassMethods
-      end
-    end
-  end
-end

data/proto_docs/google/protobuf/any.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
-
-
-module Google
-  module Protobuf
-    # `Any` contains an arbitrary serialized protocol buffer message along with a
-    # URL that describes the type of the serialized message.
-    #
-    # Protobuf library provides support to pack/unpack Any values in the form
-    # of utility functions or additional generated methods of the Any type.
-    #
-    # Example 1: Pack and unpack a message in C++.
-    #
-    #     Foo foo = ...;
-    #     Any any;
-    #     any.PackFrom(foo);
-    #     ...
-    #     if (any.UnpackTo(&foo)) {
-    #       ...
-    #     }
-    #
-    # Example 2: Pack and unpack a message in Java.
-    #
-    #     Foo foo = ...;
-    #     Any any = Any.pack(foo);
-    #     ...
-    #     if (any.is(Foo.class)) {
-    #       foo = any.unpack(Foo.class);
-    #     }
-    #
-    #  Example 3: Pack and unpack a message in Python.
-    #
-    #     foo = Foo(...)
-    #     any = Any()
-    #     any.Pack(foo)
-    #     ...
-    #     if any.Is(Foo.DESCRIPTOR):
-    #       any.Unpack(foo)
-    #       ...
-    #
-    #  Example 4: Pack and unpack a message in Go
-    #
-    #      foo := &pb.Foo{...}
-    #      any, err := anypb.New(foo)
-    #      if err != nil {
-    #        ...
-    #      }
-    #      ...
-    #      foo := &pb.Foo{}
-    #      if err := any.UnmarshalTo(foo); err != nil {
-    #        ...
-    #      }
-    #
-    # The pack methods provided by protobuf library will by default use
-    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
-    # methods only use the fully qualified type name after the last '/'
-    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
-    # name "y.z".
-    #
-    #
-    # JSON
-    # ====
-    # The JSON representation of an `Any` value uses the regular
-    # representation of the deserialized, embedded message, with an
-    # additional field `@type` which contains the type URL. Example:
-    #
-    #     package google.profile;
-    #     message Person {
-    #       string first_name = 1;
-    #       string last_name = 2;
-    #     }
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.profile.Person",
-    #       "firstName": <string>,
-    #       "lastName": <string>
-    #     }
-    #
-    # If the embedded message type is well-known and has a custom JSON
-    # representation, that representation will be embedded adding a field
-    # `value` which holds the custom JSON in addition to the `@type`
-    # field. Example (for message [google.protobuf.Duration][]):
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.protobuf.Duration",
-    #       "value": "1.212s"
-    #     }
-    # @!attribute [rw] type_url
-    #   @return [::String]
-    #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. This string must contain at least
-    #     one "/" character. The last segment of the URL's path must represent
-    #     the fully qualified name of the type (as in
-    #     `path/google.protobuf.Duration`). The name should be in a canonical form
-    #     (e.g., leading "." is not accepted).
-    #
-    #     In practice, teams usually precompile into the binary all types that they
-    #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
-    #     server that maps type URLs to message definitions as follows:
-    #
-    #     * If no scheme is provided, `https` is assumed.
-    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
-    #       value in binary format, or produce an error.
-    #     * Applications are allowed to cache lookup results based on the
-    #       URL, or have them precompiled into a binary to avoid any
-    #       lookup. Therefore, binary compatibility needs to be preserved
-    #       on changes to types. (Use versioned type names to manage
-    #       breaking changes.)
-    #
-    #     Note: this functionality is not currently available in the official
-    #     protobuf release, and it is not used for type URLs beginning with
-    #     type.googleapis.com.
-    #
-    #     Schemes other than `http`, `https` (or the empty scheme) might be
-    #     used with implementation specific semantics.
-    # @!attribute [rw] value
-    #   @return [::String]
-    #     Must be a valid serialized protocol buffer of the above specified type.
-    class Any
-      include ::Google::Protobuf::MessageExts
-      extend ::Google::Protobuf::MessageExts::ClassMethods
-    end
-  end
-end

data/proto_docs/google/protobuf/field_mask.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
-
-
-module Google
-  module Protobuf
-    # `FieldMask` represents a set of symbolic field paths, for example:
-    #
-    #     paths: "f.a"
-    #     paths: "f.b.d"
-    #
-    # Here `f` represents a field in some root message, `a` and `b`
-    # fields in the message found in `f`, and `d` a field found in the
-    # message in `f.b`.
-    #
-    # Field masks are used to specify a subset of fields that should be
-    # returned by a get operation or modified by an update operation.
-    # Field masks also have a custom JSON encoding (see below).
-    #
-    # # Field Masks in Projections
-    #
-    # When used in the context of a projection, a response message or
-    # sub-message is filtered by the API to only contain those fields as
-    # specified in the mask. For example, if the mask in the previous
-    # example is applied to a response message as follows:
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #         x : 2
-    #       }
-    #       y : 13
-    #     }
-    #     z: 8
-    #
-    # The result will not contain specific values for fields x,y and z
-    # (their value will be set to the default, and omitted in proto text
-    # output):
-    #
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #       }
-    #     }
-    #
-    # A repeated field is not allowed except at the last position of a
-    # paths string.
-    #
-    # If a FieldMask object is not present in a get operation, the
-    # operation applies to all fields (as if a FieldMask of all fields
-    # had been specified).
-    #
-    # Note that a field mask does not necessarily apply to the
-    # top-level response message. In case of a REST get operation, the
-    # field mask applies directly to the response, but in case of a REST
-    # list operation, the mask instead applies to each individual message
-    # in the returned resource list. In case of a REST custom method,
-    # other definitions may be used. Where the mask applies will be
-    # clearly documented together with its declaration in the API.  In
-    # any case, the effect on the returned resource/resources is required
-    # behavior for APIs.
-    #
-    # # Field Masks in Update Operations
-    #
-    # A field mask in update operations specifies which fields of the
-    # targeted resource are going to be updated. The API is required
-    # to only change the values of the fields as specified in the mask
-    # and leave the others untouched. If a resource is passed in to
-    # describe the updated values, the API ignores the values of all
-    # fields not covered by the mask.
-    #
-    # If a repeated field is specified for an update operation, new values will
-    # be appended to the existing repeated field in the target resource. Note that
-    # a repeated field is only allowed in the last position of a `paths` string.
-    #
-    # If a sub-message is specified in the last position of the field mask for an
-    # update operation, then new value will be merged into the existing sub-message
-    # in the target resource.
-    #
-    # For example, given the target message:
-    #
-    #     f {
-    #       b {
-    #         d: 1
-    #         x: 2
-    #       }
-    #       c: [1]
-    #     }
-    #
-    # And an update message:
-    #
-    #     f {
-    #       b {
-    #         d: 10
-    #       }
-    #       c: [2]
-    #     }
-    #
-    # then if the field mask is:
-    #
-    #  paths: ["f.b", "f.c"]
-    #
-    # then the result will be:
-    #
-    #     f {
-    #       b {
-    #         d: 10
-    #         x: 2
-    #       }
-    #       c: [1, 2]
-    #     }
-    #
-    # An implementation may provide options to override this default behavior for
-    # repeated and message fields.
-    #
-    # In order to reset a field's value to the default, the field must
-    # be in the mask and set to the default value in the provided resource.
-    # Hence, in order to reset all fields of a resource, provide a default
-    # instance of the resource and set all fields in the mask, or do
-    # not provide a mask as described below.
-    #
-    # If a field mask is not present on update, the operation applies to
-    # all fields (as if a field mask of all fields has been specified).
-    # Note that in the presence of schema evolution, this may mean that
-    # fields the client does not know and has therefore not filled into
-    # the request will be reset to their default. If this is unwanted
-    # behavior, a specific service may require a client to always specify
-    # a field mask, producing an error if not.
-    #
-    # As with get operations, the location of the resource which
-    # describes the updated values in the request message depends on the
-    # operation kind. In any case, the effect of the field mask is
-    # required to be honored by the API.
-    #
-    # ## Considerations for HTTP REST
-    #
-    # The HTTP kind of an update operation which uses a field mask must
-    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
-    # (PUT must only be used for full updates).
-    #
-    # # JSON Encoding of Field Masks
-    #
-    # In JSON, a field mask is encoded as a single string where paths are
-    # separated by a comma. Fields name in each path are converted
-    # to/from lower-camel naming conventions.
-    #
-    # As an example, consider the following message declarations:
-    #
-    #     message Profile {
-    #       User user = 1;
-    #       Photo photo = 2;
-    #     }
-    #     message User {
-    #       string display_name = 1;
-    #       string address = 2;
-    #     }
-    #
-    # In proto a field mask for `Profile` may look as such:
-    #
-    #     mask {
-    #       paths: "user.display_name"
-    #       paths: "photo"
-    #     }
-    #
-    # In JSON, the same mask is represented as below:
-    #
-    #     {
-    #       mask: "user.displayName,photo"
-    #     }
-    #
-    # # Field Masks and Oneof Fields
-    #
-    # Field masks treat fields in oneofs just as regular fields. Consider the
-    # following message:
-    #
-    #     message SampleMessage {
-    #       oneof test_oneof {
-    #         string name = 4;
-    #         SubMessage sub_message = 9;
-    #       }
-    #     }
-    #
-    # The field mask can be:
-    #
-    #     mask {
-    #       paths: "name"
-    #     }
-    #
-    # Or:
-    #
-    #     mask {
-    #       paths: "sub_message"
-    #     }
-    #
-    # Note that oneof type names ("test_oneof" in this case) cannot be used in
-    # paths.
-    #
-    # ## Field Mask Verification
-    #
-    # The implementation of any API method which has a FieldMask type field in the
-    # request should verify the included field paths, and return an
-    # `INVALID_ARGUMENT` error if any path is unmappable.
-    # @!attribute [rw] paths
-    #   @return [::Array<::String>]
-    #     The set of field mask paths.
-    class FieldMask
-      include ::Google::Protobuf::MessageExts
-      extend ::Google::Protobuf::MessageExts::ClassMethods
-    end
-  end
-end