google-cloud-service_control-v1 0.1.0

data/proto_docs/google/api/servicecontrol/v1/distribution.rb

@@ -0,0 +1,148 @@
+# 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 Cloud
+    module ServiceControl
+      module V1
+        # 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
+        # @!attribute [rw] count
+        #   @return [::Integer]
+        #     The total number of samples in the distribution. Must be >= 0.
+        # @!attribute [rw] mean
+        #   @return [::Float]
+        #     The arithmetic mean of the samples in the distribution. If `count` is
+        #     zero then this field must be zero.
+        # @!attribute [rw] minimum
+        #   @return [::Float]
+        #     The minimum of the population of values. Ignored if `count` is zero.
+        # @!attribute [rw] maximum
+        #   @return [::Float]
+        #     The maximum of the population of values. Ignored if `count` is zero.
+        # @!attribute [rw] sum_of_squared_deviation
+        #   @return [::Float]
+        #     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.
+        # @!attribute [rw] bucket_counts
+        #   @return [::Array<::Integer>]
+        #     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.
+        # @!attribute [rw] linear_buckets
+        #   @return [::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets]
+        #     Buckets with constant width.
+        # @!attribute [rw] exponential_buckets
+        #   @return [::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets]
+        #     Buckets with exponentially growing width.
+        # @!attribute [rw] explicit_buckets
+        #   @return [::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets]
+        #     Buckets with arbitrary user-provided width.
+        class Distribution
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describing buckets with constant width.
+          # @!attribute [rw] num_finite_buckets
+          #   @return [::Integer]
+          #     The number of finite buckets. With the underflow and overflow buckets,
+          #     the total number of buckets is `num_finite_buckets` + 2.
+          #     See comments on `bucket_options` for details.
+          # @!attribute [rw] width
+          #   @return [::Float]
+          #     The i'th linear bucket covers the interval
+          #       [offset + (i-1) * width, offset + i * width)
+          #     where i ranges from 1 to num_finite_buckets, inclusive.
+          #     Must be strictly positive.
+          # @!attribute [rw] offset
+          #   @return [::Float]
+          #     The i'th linear bucket covers the interval
+          #       [offset + (i-1) * width, offset + i * width)
+          #     where i ranges from 1 to num_finite_buckets, inclusive.
+          class LinearBuckets
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describing buckets with exponentially growing width.
+          # @!attribute [rw] num_finite_buckets
+          #   @return [::Integer]
+          #     The number of finite buckets. With the underflow and overflow buckets,
+          #     the total number of buckets is `num_finite_buckets` + 2.
+          #     See comments on `bucket_options` for details.
+          # @!attribute [rw] growth_factor
+          #   @return [::Float]
+          #     The i'th exponential bucket covers the interval
+          #       [scale * growth_factor^(i-1), scale * growth_factor^i)
+          #     where i ranges from 1 to num_finite_buckets inclusive.
+          #     Must be larger than 1.0.
+          # @!attribute [rw] scale
+          #   @return [::Float]
+          #     The i'th exponential bucket covers the interval
+          #       [scale * growth_factor^(i-1), scale * growth_factor^i)
+          #     where i ranges from 1 to num_finite_buckets inclusive.
+          #     Must be > 0.
+          class ExponentialBuckets
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describing buckets with arbitrary user-provided width.
+          # @!attribute [rw] bounds
+          #   @return [::Array<::Float>]
+          #     'bound' is a list of strictly increasing boundaries between
+          #     buckets. Note that a list of length N-1 defines N buckets because
+          #     of fenceposting. See comments on `bucket_options` for details.
+          #
+          #     The i'th finite bucket covers the interval
+          #       [bound[i-1], bound[i])
+          #     where i ranges from 1 to bound_size() - 1. Note that there are no
+          #     finite buckets at all if 'bound' only contains a single element; in
+          #     that special case the single bound defines the boundary between the
+          #     underflow and overflow buckets.
+          #
+          #     bucket number                   lower bound    upper bound
+          #      i == 0 (underflow)              -inf           bound[i]
+          #      0 < i < bound_size()            bound[i-1]     bound[i]
+          #      i == bound_size() (overflow)    bound[i-1]     +inf
+          class ExplicitBuckets
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/servicecontrol/v1/http_request.rb

@@ -0,0 +1,95 @@
+# 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 Cloud
+    module ServiceControl
+      module V1
+        # A common proto for logging HTTP requests. Only contains semantics
+        # defined by the HTTP specification. Product-specific logging
+        # information MUST be defined in a separate message.
+        # @!attribute [rw] request_method
+        #   @return [::String]
+        #     The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
+        # @!attribute [rw] request_url
+        #   @return [::String]
+        #     The scheme (http, https), the host name, the path, and the query
+        #     portion of the URL that was requested.
+        #     Example: `"http://example.com/some/info?color=red"`.
+        # @!attribute [rw] request_size
+        #   @return [::Integer]
+        #     The size of the HTTP request message in bytes, including the request
+        #     headers and the request body.
+        # @!attribute [rw] status
+        #   @return [::Integer]
+        #     The response code indicating the status of the response.
+        #     Examples: 200, 404.
+        # @!attribute [rw] response_size
+        #   @return [::Integer]
+        #     The size of the HTTP response message sent back to the client, in bytes,
+        #     including the response headers and the response body.
+        # @!attribute [rw] user_agent
+        #   @return [::String]
+        #     The user agent sent by the client. Example:
+        #     `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET
+        #     CLR 1.0.3705)"`.
+        # @!attribute [rw] remote_ip
+        #   @return [::String]
+        #     The IP address (IPv4 or IPv6) of the client that issued the HTTP
+        #     request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+        # @!attribute [rw] server_ip
+        #   @return [::String]
+        #     The IP address (IPv4 or IPv6) of the origin server that the request was
+        #     sent to.
+        # @!attribute [rw] referer
+        #   @return [::String]
+        #     The referer URL of the request, as defined in
+        #     [HTTP/1.1 Header Field
+        #     Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+        # @!attribute [rw] latency
+        #   @return [::Google::Protobuf::Duration]
+        #     The request processing latency on the server, from the time the request was
+        #     received until the response was sent.
+        # @!attribute [rw] cache_lookup
+        #   @return [::Boolean]
+        #     Whether or not a cache lookup was attempted.
+        # @!attribute [rw] cache_hit
+        #   @return [::Boolean]
+        #     Whether or not an entity was served from cache
+        #     (with or without validation).
+        # @!attribute [rw] cache_validated_with_origin_server
+        #   @return [::Boolean]
+        #     Whether or not the response was validated with the origin server before
+        #     being served from cache. This field is only meaningful if `cache_hit` is
+        #     True.
+        # @!attribute [rw] cache_fill_bytes
+        #   @return [::Integer]
+        #     The number of HTTP response bytes inserted into cache. Set only when a
+        #     cache fill was attempted.
+        # @!attribute [rw] protocol
+        #   @return [::String]
+        #     Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
+        class HttpRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/servicecontrol/v1/log_entry.rb

@@ -0,0 +1,136 @@
+# 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 Cloud
+    module ServiceControl
+      module V1
+        # An individual log entry.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The log to which this log entry belongs. Examples: `"syslog"`,
+        #     `"book_log"`.
+        # @!attribute [rw] timestamp
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time the event described by the log entry occurred. If
+        #     omitted, defaults to operation start time.
+        # @!attribute [rw] severity
+        #   @return [::Google::Logging::Type::LogSeverity]
+        #     The severity of the log entry. The default value is
+        #     `LogSeverity.DEFAULT`.
+        # @!attribute [rw] http_request
+        #   @return [::Google::Cloud::ServiceControl::V1::HttpRequest]
+        #     Optional. Information about the HTTP request associated with this
+        #     log entry, if applicable.
+        # @!attribute [rw] trace
+        #   @return [::String]
+        #     Optional. Resource name of the trace associated with the log entry, if any.
+        #     If this field contains a relative resource name, you can assume the name is
+        #     relative to `//tracing.googleapis.com`. Example:
+        #     `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
+        # @!attribute [rw] insert_id
+        #   @return [::String]
+        #     A unique ID for the log entry used for deduplication. If omitted,
+        #     the implementation will generate one based on operation_id.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A set of user-defined (key, value) data that provides additional
+        #     information about the log entry.
+        # @!attribute [rw] proto_payload
+        #   @return [::Google::Protobuf::Any]
+        #     The log entry payload, represented as a protocol buffer that is
+        #     expressed as a JSON object. The only accepted type currently is
+        #     [AuditLog][google.cloud.audit.AuditLog].
+        # @!attribute [rw] text_payload
+        #   @return [::String]
+        #     The log entry payload, represented as a Unicode string (UTF-8).
+        # @!attribute [rw] struct_payload
+        #   @return [::Google::Protobuf::Struct]
+        #     The log entry payload, represented as a structure that
+        #     is expressed as a JSON object.
+        # @!attribute [rw] operation
+        #   @return [::Google::Cloud::ServiceControl::V1::LogEntryOperation]
+        #     Optional. Information about an operation associated with the log entry, if
+        #     applicable.
+        # @!attribute [rw] source_location
+        #   @return [::Google::Cloud::ServiceControl::V1::LogEntrySourceLocation]
+        #     Optional. Source code location information associated with the log entry,
+        #     if any.
+        class LogEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Additional information about a potentially long-running operation with which
+        # a log entry is associated.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Optional. An arbitrary operation identifier. Log entries with the
+        #     same identifier are assumed to be part of the same operation.
+        # @!attribute [rw] producer
+        #   @return [::String]
+        #     Optional. An arbitrary producer identifier. The combination of
+        #     `id` and `producer` must be globally unique.  Examples for `producer`:
+        #     `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
+        # @!attribute [rw] first
+        #   @return [::Boolean]
+        #     Optional. Set this to True if this is the first log entry in the operation.
+        # @!attribute [rw] last
+        #   @return [::Boolean]
+        #     Optional. Set this to True if this is the last log entry in the operation.
+        class LogEntryOperation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Additional information about the source code location that produced the log
+        # entry.
+        # @!attribute [rw] file
+        #   @return [::String]
+        #     Optional. Source file name. Depending on the runtime environment, this
+        #     might be a simple name or a fully-qualified name.
+        # @!attribute [rw] line
+        #   @return [::Integer]
+        #     Optional. Line within the source file. 1-based; 0 indicates no line number
+        #     available.
+        # @!attribute [rw] function
+        #   @return [::String]
+        #     Optional. Human-readable name of the function or method being invoked, with
+        #     optional context such as the class or package name. This information may be
+        #     used in contexts such as the logs viewer, where a file and line number are
+        #     less meaningful. The format can vary by language. For example:
+        #     `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`
+        #     (Python).
+        class LogEntrySourceLocation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/servicecontrol/v1/metric_value.rb

@@ -0,0 +1,86 @@
+# 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 Cloud
+    module ServiceControl
+      module V1
+        # Represents a single metric value.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels describing the metric value.
+        #     See comments on {::Google::Cloud::ServiceControl::V1::Operation#labels google.api.servicecontrol.v1.Operation.labels} for
+        #     the overriding relationship.
+        #     Note that this map must not contain monitored resource labels.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The start of the time period over which this metric value's measurement
+        #     applies. The time period has different semantics for different metric
+        #     types (cumulative, delta, and gauge). See the metric definition
+        #     documentation in the service configuration for details.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The end of the time period over which this metric value's measurement
+        #     applies.
+        # @!attribute [rw] bool_value
+        #   @return [::Boolean]
+        #     A boolean value.
+        # @!attribute [rw] int64_value
+        #   @return [::Integer]
+        #     A signed 64-bit integer value.
+        # @!attribute [rw] double_value
+        #   @return [::Float]
+        #     A double precision floating point value.
+        # @!attribute [rw] string_value
+        #   @return [::String]
+        #     A text string value.
+        # @!attribute [rw] distribution_value
+        #   @return [::Google::Cloud::ServiceControl::V1::Distribution]
+        #     A distribution value.
+        class MetricValue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Represents a set of metric values in the same metric.
+        # Each metric value in the set should have a unique combination of start time,
+        # end time, and label values.
+        # @!attribute [rw] metric_name
+        #   @return [::String]
+        #     The metric name defined in the service configuration.
+        # @!attribute [rw] metric_values
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::MetricValue>]
+        #     The values in this metric.
+        class MetricValueSet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end