google-cloud-logging 1.10.5 → 2.0.0

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb

@@ -1,220 +0,0 @@
-# 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.
-
-
-module Google
-  module Logging
-    module V2
-      # Describes a logs-based metric. The value of the metric is the number of log
-      # entries that match a logs filter in a given time interval.
-      #
-      # Logs-based metric can also be used to extract values from logs and create a
-      # a distribution of the values. The distribution records the statistics of the
-      # extracted values along with an optional histogram of the values as specified
-      # by the bucket options.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The client-assigned metric identifier.
-      #     Examples: `"error_count"`, `"nginx/requests"`.
-      #
-      #     Metric identifiers are limited to 100 characters and can include only the
-      #     following characters: `A-Z`, `a-z`, `0-9`, and the special characters
-      #     `_-.,+!*',()%/`. The forward-slash character (`/`) denotes a hierarchy of
-      #     name pieces, and it cannot be the first character of the name.
-      #
-      #     The metric identifier in this field must not be
-      #     [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
-      #     However, when the metric identifier appears as the `[METRIC_ID]` part of a
-      #     `metric_name` API parameter, then the metric identifier must be
-      #     URL-encoded. Example: `"projects/my-project/metrics/nginx%2Frequests"`.
-      # @!attribute [rw] description
-      #   @return [String]
-      #     Optional. A description of this metric, which is used in documentation.
-      #     The maximum length of the description is 8000 characters.
-      # @!attribute [rw] filter
-      #   @return [String]
-      #     Required. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced_filters) which is
-      #     used to match log entries.
-      #     Example:
-      #
-      #         "resource.type=gae_app AND severity>=ERROR"
-      #
-      #     The maximum length of the filter is 20000 characters.
-      # @!attribute [rw] metric_descriptor
-      #   @return [Google::Api::MetricDescriptor]
-      #     Optional. The metric descriptor associated with the logs-based metric.
-      #     If unspecified, it uses a default metric descriptor with a DELTA metric
-      #     kind, INT64 value type, with no labels and a unit of "1". Such a metric
-      #     counts the number of log entries matching the `filter` expression.
-      #
-      #     The `name`, `type`, and `description` fields in the `metric_descriptor`
-      #     are output only, and is constructed using the `name` and `description`
-      #     field in the LogMetric.
-      #
-      #     To create a logs-based metric that records a distribution of log values, a
-      #     DELTA metric kind with a DISTRIBUTION value type must be used along with
-      #     a `value_extractor` expression in the LogMetric.
-      #
-      #     Each label in the metric descriptor must have a matching label
-      #     name as the key and an extractor expression as the value in the
-      #     `label_extractors` map.
-      #
-      #     The `metric_kind` and `value_type` fields in the `metric_descriptor` cannot
-      #     be updated once initially configured. New labels can be added in the
-      #     `metric_descriptor`, but existing labels cannot be modified except for
-      #     their description.
-      # @!attribute [rw] value_extractor
-      #   @return [String]
-      #     Optional. A `value_extractor` is required when using a distribution
-      #     logs-based metric to extract the values to record from a log entry.
-      #     Two functions are supported for value extraction: `EXTRACT(field)` or
-      #     `REGEXP_EXTRACT(field, regex)`. The argument are:
-      #       1. field: The name of the log entry field from which the value is to be
-      #          extracted.
-      #       2. regex: A regular expression using the Google RE2 syntax
-      #          (https://github.com/google/re2/wiki/Syntax) with a single capture
-      #          group to extract data from the specified log entry field. The value
-      #          of the field is converted to a string before applying the regex.
-      #          It is an error to specify a regex that does not include exactly one
-      #          capture group.
-      #
-      #     The result of the extraction must be convertible to a double type, as the
-      #     distribution always records double values. If either the extraction or
-      #     the conversion to double fails, then those values are not recorded in the
-      #     distribution.
-      #
-      #     Example: `REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*")`
-      # @!attribute [rw] label_extractors
-      #   @return [Hash{String => String}]
-      #     Optional. A map from a label key string to an extractor expression which is
-      #     used to extract data from a log entry field and assign as the label value.
-      #     Each label key specified in the LabelDescriptor must have an associated
-      #     extractor expression in this map. The syntax of the extractor expression
-      #     is the same as for the `value_extractor` field.
-      #
-      #     The extracted value is converted to the type defined in the label
-      #     descriptor. If the either the extraction or the type conversion fails,
-      #     the label will have a default value. The default value for a string
-      #     label is an empty string, for an integer label its 0, and for a boolean
-      #     label its `false`.
-      #
-      #     Note that there are upper bounds on the maximum number of labels and the
-      #     number of active time series that are allowed in a project.
-      # @!attribute [rw] bucket_options
-      #   @return [Google::Api::Distribution::BucketOptions]
-      #     Optional. The `bucket_options` are required when the logs-based metric is
-      #     using a DISTRIBUTION value type and it describes the bucket boundaries
-      #     used to create a histogram of the extracted values.
-      # @!attribute [rw] create_time
-      #   @return [Google::Protobuf::Timestamp]
-      #     Output only. The creation timestamp of the metric.
-      #
-      #     This field may not be present for older metrics.
-      # @!attribute [rw] update_time
-      #   @return [Google::Protobuf::Timestamp]
-      #     Output only. The last update timestamp of the metric.
-      #
-      #     This field may not be present for older metrics.
-      # @!attribute [rw] version
-      #   @return [Google::Logging::V2::LogMetric::ApiVersion]
-      #     Deprecated. The API version that created or updated this metric.
-      #     The v2 format is used by default and cannot be changed.
-      class LogMetric
-        # Logging API version.
-        module ApiVersion
-          # Logging API v2.
-          V2 = 0
-
-          # Logging API v1.
-          V1 = 1
-        end
-      end
-
-      # The parameters to ListLogMetrics.
-      # @!attribute [rw] parent
-      #   @return [String]
-      #     Required. The name of the project containing the metrics:
-      #
-      #         "projects/[PROJECT_ID]"
-      # @!attribute [rw] page_token
-      #   @return [String]
-      #     Optional. If present, then retrieve the next batch of results from the
-      #     preceding call to this method. `pageToken` must be the value of
-      #     `nextPageToken` from the previous response. The values of other method
-      #     parameters should be identical to those in the previous call.
-      # @!attribute [rw] page_size
-      #   @return [Integer]
-      #     Optional. The maximum number of results to return from this request.
-      #     Non-positive values are ignored. The presence of `nextPageToken` in the
-      #     response indicates that more results might be available.
-      class ListLogMetricsRequest; end
-
-      # Result returned from ListLogMetrics.
-      # @!attribute [rw] metrics
-      #   @return [Array<Google::Logging::V2::LogMetric>]
-      #     A list of logs-based metrics.
-      # @!attribute [rw] next_page_token
-      #   @return [String]
-      #     If there might be more results than appear in this response, then
-      #     `nextPageToken` is included. To get the next set of results, call this
-      #     method again using the value of `nextPageToken` as `pageToken`.
-      class ListLogMetricsResponse; end
-
-      # The parameters to GetLogMetric.
-      # @!attribute [rw] metric_name
-      #   @return [String]
-      #     Required. The resource name of the desired metric:
-      #
-      #         "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
-      class GetLogMetricRequest; end
-
-      # The parameters to CreateLogMetric.
-      # @!attribute [rw] parent
-      #   @return [String]
-      #     Required. The resource name of the project in which to create the metric:
-      #
-      #         "projects/[PROJECT_ID]"
-      #
-      #     The new metric must be provided in the request.
-      # @!attribute [rw] metric
-      #   @return [Google::Logging::V2::LogMetric]
-      #     Required. The new logs-based metric, which must not have an identifier that
-      #     already exists.
-      class CreateLogMetricRequest; end
-
-      # The parameters to UpdateLogMetric.
-      # @!attribute [rw] metric_name
-      #   @return [String]
-      #     Required. The resource name of the metric to update:
-      #
-      #         "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
-      #
-      #     The updated metric must be provided in the request and it's
-      #     `name` field must be the same as `[METRIC_ID]` If the metric
-      #     does not exist in `[PROJECT_ID]`, then a new metric is created.
-      # @!attribute [rw] metric
-      #   @return [Google::Logging::V2::LogMetric]
-      #     Required. The updated metric.
-      class UpdateLogMetricRequest; end
-
-      # The parameters to DeleteLogMetric.
-      # @!attribute [rw] metric_name
-      #   @return [String]
-      #     Required. The resource name of the metric to delete:
-      #
-      #         "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
-      class DeleteLogMetricRequest; end
-    end
-  end
-end

data/lib/google/cloud/logging/v2/doc/google/protobuf/any.rb

@@ -1,131 +0,0 @@
-# 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.
-
-
-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 := ptypes.MarshalAny(foo)
-    #      ...
-    #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, 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; end
-  end
-end

data/lib/google/cloud/logging/v2/doc/google/protobuf/duration.rb

@@ -1,91 +0,0 @@
-# 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.
-
-
-module Google
-  module Protobuf
-    # A Duration represents a signed, fixed-length span of time represented
-    # as a count of seconds and fractions of seconds at nanosecond
-    # resolution. It is independent of any calendar and concepts like "day"
-    # or "month". It is related to Timestamp in that the difference between
-    # two Timestamp values is a Duration and it can be added or subtracted
-    # from a Timestamp. Range is approximately +-10,000 years.
-    #
-    # = Examples
-    #
-    # Example 1: Compute Duration from two Timestamps in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Timestamp end = ...;
-    #     Duration duration = ...;
-    #
-    #     duration.seconds = end.seconds - start.seconds;
-    #     duration.nanos = end.nanos - start.nanos;
-    #
-    #     if (duration.seconds < 0 && duration.nanos > 0) {
-    #       duration.seconds += 1;
-    #       duration.nanos -= 1000000000;
-    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
-    #       duration.seconds -= 1;
-    #       duration.nanos += 1000000000;
-    #     }
-    #
-    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Duration duration = ...;
-    #     Timestamp end = ...;
-    #
-    #     end.seconds = start.seconds + duration.seconds;
-    #     end.nanos = start.nanos + duration.nanos;
-    #
-    #     if (end.nanos < 0) {
-    #       end.seconds -= 1;
-    #       end.nanos += 1000000000;
-    #     } else if (end.nanos >= 1000000000) {
-    #       end.seconds += 1;
-    #       end.nanos -= 1000000000;
-    #     }
-    #
-    # Example 3: Compute Duration from datetime.timedelta in Python.
-    #
-    #     td = datetime.timedelta(days=3, minutes=10)
-    #     duration = Duration()
-    #     duration.FromTimedelta(td)
-    #
-    # = JSON Mapping
-    #
-    # In JSON format, the Duration type is encoded as a string rather than an
-    # object, where the string ends in the suffix "s" (indicating seconds) and
-    # is preceded by the number of seconds, with nanoseconds expressed as
-    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
-    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
-    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
-    # microsecond should be expressed in JSON format as "3.000001s".
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
-    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Signed fractions of a second at nanosecond resolution of the span
-    #     of time. Durations less than one second are represented with a 0
-    #     `seconds` field and a positive or negative `nanos` field. For durations
-    #     of one second or more, a non-zero value for the `nanos` field must be
-    #     of the same sign as the `seconds` field. Must be from -999,999,999
-    #     to +999,999,999 inclusive.
-    class Duration; end
-  end
-end

data/lib/google/cloud/logging/v2/doc/google/protobuf/empty.rb

@@ -1,29 +0,0 @@
-# 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.
-
-
-module Google
-  module Protobuf
-    # A generic empty message that you can re-use to avoid defining duplicated
-    # empty messages in your APIs. A typical example is to use it as the request
-    # or the response type of an API method. For instance:
-    #
-    #     service Foo {
-    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-    #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
-    class Empty; end
-  end
-end