google-cloud-monitoring-v3 0.1.0

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/label.rb

@@ -0,0 +1,49 @@
+# 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
+    # A description of a label.
+    # @!attribute [rw] key
+    #   @return [::String]
+    #     The label key.
+    # @!attribute [rw] value_type
+    #   @return [::Google::Api::LabelDescriptor::ValueType]
+    #     The type of data that can be assigned to the label.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     A human-readable description for the label.
+    class LabelDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Value types that can be used as label values.
+      module ValueType
+        # A variable-length string. This is the default.
+        STRING = 0
+
+        # Boolean; true or false.
+        BOOL = 1
+
+        # A 64-bit signed integer.
+        INT64 = 2
+      end
+    end
+  end
+end

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,65 @@
+# 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
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](http://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects whitelisted. Alpha releases don’t have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the “Deprecation Policy” section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

data/proto_docs/google/api/metric.rb

@@ -0,0 +1,203 @@
+# 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
+    # Defines a metric type and its schema. Once a metric descriptor is created,
+    # deleting or altering it stops data collection and makes the metric type's
+    # existing data unusable.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The resource name of the metric descriptor.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The metric type, including its DNS name prefix. The type is not
+    #     URL-encoded.  All user-defined custom metric types have the DNS name
+    #     `custom.googleapis.com`.  Metric types should use a natural hierarchical
+    #     grouping. For example:
+    #
+    #         "custom.googleapis.com/invoice/paid/amount"
+    #         "appengine.googleapis.com/http/server/response_latencies"
+    # @!attribute [rw] labels
+    #   @return [::Array<::Google::Api::LabelDescriptor>]
+    #     The set of labels that can be used to describe a specific
+    #     instance of this metric type. For example, the
+    #     `appengine.googleapis.com/http/server/response_latencies` metric
+    #     type has a label for the HTTP response code, `response_code`, so
+    #     you can look at latencies for successful responses or just
+    #     for responses that failed.
+    # @!attribute [rw] metric_kind
+    #   @return [::Google::Api::MetricDescriptor::MetricKind]
+    #     Whether the metric records instantaneous values, changes to a value, etc.
+    #     Some combinations of `metric_kind` and `value_type` might not be supported.
+    # @!attribute [rw] value_type
+    #   @return [::Google::Api::MetricDescriptor::ValueType]
+    #     Whether the measurement is an integer, a floating-point number, etc.
+    #     Some combinations of `metric_kind` and `value_type` might not be supported.
+    # @!attribute [rw] unit
+    #   @return [::String]
+    #     The unit in which the metric value is reported. It is only applicable
+    #     if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
+    #     supported units are a subset of [The Unified Code for Units of
+    #     Measure](http://unitsofmeasure.org/ucum.html) standard:
+    #
+    #     **Basic units (UNIT)**
+    #
+    #     * `bit`   bit
+    #     * `By`    byte
+    #     * `s`     second
+    #     * `min`   minute
+    #     * `h`     hour
+    #     * `d`     day
+    #
+    #     **Prefixes (PREFIX)**
+    #
+    #     * `k`     kilo    (10**3)
+    #     * `M`     mega    (10**6)
+    #     * `G`     giga    (10**9)
+    #     * `T`     tera    (10**12)
+    #     * `P`     peta    (10**15)
+    #     * `E`     exa     (10**18)
+    #     * `Z`     zetta   (10**21)
+    #     * `Y`     yotta   (10**24)
+    #     * `m`     milli   (10**-3)
+    #     * `u`     micro   (10**-6)
+    #     * `n`     nano    (10**-9)
+    #     * `p`     pico    (10**-12)
+    #     * `f`     femto   (10**-15)
+    #     * `a`     atto    (10**-18)
+    #     * `z`     zepto   (10**-21)
+    #     * `y`     yocto   (10**-24)
+    #     * `Ki`    kibi    (2**10)
+    #     * `Mi`    mebi    (2**20)
+    #     * `Gi`    gibi    (2**30)
+    #     * `Ti`    tebi    (2**40)
+    #
+    #     **Grammar**
+    #
+    #     The grammar also includes these connectors:
+    #
+    #     * `/`    division (as an infix operator, e.g. `1/s`).
+    #     * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
+    #
+    #     The grammar for a unit is as follows:
+    #
+    #         Expression = Component { "." Component } { "/" Component } ;
+    #
+    #         Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
+    #                   | Annotation
+    #                   | "1"
+    #                   ;
+    #
+    #         Annotation = "{" NAME "}" ;
+    #
+    #     Notes:
+    #
+    #     * `Annotation` is just a comment if it follows a `UNIT` and is
+    #        equivalent to `1` if it is used alone. For examples,
+    #        `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
+    #     * `NAME` is a sequence of non-blank printable ASCII characters not
+    #        containing '\\{' or '}'.
+    #     * `1` represents dimensionless value 1, such as in `1/s`.
+    #     * `%` represents dimensionless value 1/100, and annotates values giving
+    #        a percentage.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     A detailed description of the metric, which can be used in documentation.
+    # @!attribute [rw] display_name
+    #   @return [::String]
+    #     A concise name for the metric, which can be displayed in user interfaces.
+    #     Use sentence case without an ending period, for example "Request count".
+    #     This field is optional but it is recommended to be set for any metrics
+    #     associated with user-visible concepts, such as Quota.
+    class MetricDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # The kind of measurement. It describes how the data is reported.
+      module MetricKind
+        # Do not use this default value.
+        METRIC_KIND_UNSPECIFIED = 0
+
+        # An instantaneous measurement of a value.
+        GAUGE = 1
+
+        # The change in a value during a time interval.
+        DELTA = 2
+
+        # A value accumulated over a time interval.  Cumulative
+        # measurements in a time series should have the same start time
+        # and increasing end times, until an event resets the cumulative
+        # value to zero and sets a new start time for the following
+        # points.
+        CUMULATIVE = 3
+      end
+
+      # The value type of a metric.
+      module ValueType
+        # Do not use this default value.
+        VALUE_TYPE_UNSPECIFIED = 0
+
+        # The value is a boolean.
+        # This value type can be used only if the metric kind is `GAUGE`.
+        BOOL = 1
+
+        # The value is a signed 64-bit integer.
+        INT64 = 2
+
+        # The value is a double precision floating point number.
+        DOUBLE = 3
+
+        # The value is a text string.
+        # This value type can be used only if the metric kind is `GAUGE`.
+        STRING = 4
+
+        # The value is a {::Google::Api::Distribution `Distribution`}.
+        DISTRIBUTION = 5
+
+        # The value is money.
+        MONEY = 6
+      end
+    end
+
+    # A specific metric, identified by specifying values for all of the
+    # labels of a {::Google::Api::MetricDescriptor `MetricDescriptor`}.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     An existing metric type, see {::Google::Api::MetricDescriptor google.api.MetricDescriptor}.
+    #     For example, `custom.googleapis.com/invoice/paid/amount`.
+    # @!attribute [rw] labels
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     The set of label values that uniquely identify this metric. All
+    #     labels listed in the `MetricDescriptor` must be assigned values.
+    class Metric
+      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
+  end
+end

data/proto_docs/google/api/monitored_resource.rb

@@ -0,0 +1,137 @@
+# 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
+    # An object that describes the schema of a {::Google::Api::MonitoredResource MonitoredResource} object using a
+    # type name and a set of labels.  For example, the monitored resource
+    # descriptor for Google Compute Engine VM instances has a type of
+    # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
+    # `"zone"` to identify particular VM instances.
+    #
+    # Different APIs can support different monitored resource types. APIs generally
+    # provide a `list` method that returns the monitored resource descriptors used
+    # by the API.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     Optional. The resource name of the monitored resource descriptor:
+    #     `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
+    #     \\{type} is the value of the `type` field in this object and
+    #     \\{project_id} is a project ID that provides API-specific context for
+    #     accessing the type.  APIs that do not use project information can use the
+    #     resource name format `"monitoredResourceDescriptors/{type}"`.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     Required. The monitored resource type. For example, the type
+    #     `"cloudsql_database"` represents databases in Google Cloud SQL.
+    #     The maximum length of this value is 256 characters.
+    # @!attribute [rw] display_name
+    #   @return [::String]
+    #     Optional. A concise name for the monitored resource type that might be
+    #     displayed in user interfaces. It should be a Title Cased Noun Phrase,
+    #     without any article or other determiners. For example,
+    #     `"Google Cloud SQL Database"`.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     Optional. A detailed description of the monitored resource type that might
+    #     be used in documentation.
+    # @!attribute [rw] labels
+    #   @return [::Array<::Google::Api::LabelDescriptor>]
+    #     Required. A set of labels used to describe instances of this monitored
+    #     resource type. For example, an individual Google Cloud SQL database is
+    #     identified by values for the labels `"database_id"` and `"zone"`.
+    class MonitoredResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # An object representing a resource that can be used for monitoring, logging,
+    # billing, or other purposes. Examples include virtual machine instances,
+    # databases, and storage devices such as disks. The `type` field identifies a
+    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object that describes the resource's
+    # schema. Information in the `labels` field identifies the actual resource and
+    # its attributes according to the schema. For example, a particular Compute
+    # Engine VM instance could be represented by the following object, because the
+    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
+    # `"instance_id"` and `"zone"`:
+    #
+    #     { "type": "gce_instance",
+    #       "labels": { "instance_id": "12345678901234",
+    #                   "zone": "us-central1-a" }}
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     Required. The monitored resource type. This field must match
+    #     the `type` field of a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
+    #     example, the type of a Compute Engine VM instance is `gce_instance`.
+    # @!attribute [rw] labels
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Required. Values for all of the labels listed in the associated monitored
+    #     resource descriptor. For example, Compute Engine VM instances use the
+    #     labels `"project_id"`, `"instance_id"`, and `"zone"`.
+    class MonitoredResource
+      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
+
+    # Auxiliary metadata for a {::Google::Api::MonitoredResource MonitoredResource} object.
+    # {::Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
+    # uniquely identify a monitored resource instance. There is some other useful
+    # auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
+    # pipeline to extract metadata for cloud resources of all types , and stores
+    # the metadata in this message.
+    # @!attribute [rw] system_labels
+    #   @return [::Google::Protobuf::Struct]
+    #     Output only. Values for predefined system metadata labels.
+    #     System labels are a kind of metadata extracted by Google Stackdriver.
+    #     Stackdriver determines what system labels are useful and how to obtain
+    #     their values. Some examples: "machine_image", "vpc", "subnet_id",
+    #     "security_group", "name", etc.
+    #     System label values can be only strings, Boolean values, or a list of
+    #     strings. For example:
+    #
+    #         { "name": "my-test-instance",
+    #           "security_group": ["a", "b", "c"],
+    #           "spot_instance": false }
+    # @!attribute [rw] user_labels
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Output only. A map of user-defined metadata labels.
+    class MonitoredResourceMetadata
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class UserLabelsEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end