google-cloud-monitoring-v3 0.8.0 → 0.10.0

data/proto_docs/google/api/client.rb

@@ -0,0 +1,318 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+    # Required information for every language.
+    # @!attribute [rw] reference_docs_uri
+    #   @return [::String]
+    #     Link to automatically generated reference documentation.  Example:
+    #     https://cloud.google.com/nodejs/docs/reference/asset/latest
+    # @!attribute [rw] destinations
+    #   @return [::Array<::Google::Api::ClientLibraryDestination>]
+    #     The destination where API teams want this client library to be published.
+    class CommonLanguageSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Details about how and where to publish client libraries.
+    # @!attribute [rw] version
+    #   @return [::String]
+    #     Version of the API to apply these settings to.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Launch stage of this version of the API.
+    # @!attribute [rw] rest_numeric_enums
+    #   @return [::Boolean]
+    #     When using transport=rest, the client request will encode enums as
+    #     numbers rather than strings.
+    # @!attribute [rw] java_settings
+    #   @return [::Google::Api::JavaSettings]
+    #     Settings for legacy Java features, supported in the Service YAML.
+    # @!attribute [rw] cpp_settings
+    #   @return [::Google::Api::CppSettings]
+    #     Settings for C++ client libraries.
+    # @!attribute [rw] php_settings
+    #   @return [::Google::Api::PhpSettings]
+    #     Settings for PHP client libraries.
+    # @!attribute [rw] python_settings
+    #   @return [::Google::Api::PythonSettings]
+    #     Settings for Python client libraries.
+    # @!attribute [rw] node_settings
+    #   @return [::Google::Api::NodeSettings]
+    #     Settings for Node client libraries.
+    # @!attribute [rw] dotnet_settings
+    #   @return [::Google::Api::DotnetSettings]
+    #     Settings for .NET client libraries.
+    # @!attribute [rw] ruby_settings
+    #   @return [::Google::Api::RubySettings]
+    #     Settings for Ruby client libraries.
+    # @!attribute [rw] go_settings
+    #   @return [::Google::Api::GoSettings]
+    #     Settings for Go client libraries.
+    class ClientLibrarySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # This message configures the settings for publishing [Google Cloud Client
+    # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
+    # generated from the service config.
+    # @!attribute [rw] method_settings
+    #   @return [::Array<::Google::Api::MethodSettings>]
+    #     A list of API method settings, e.g. the behavior for methods that use the
+    #     long-running operation pattern.
+    # @!attribute [rw] new_issue_uri
+    #   @return [::String]
+    #     Link to a place that API users can report issues.  Example:
+    #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
+    # @!attribute [rw] documentation_uri
+    #   @return [::String]
+    #     Link to product home page.  Example:
+    #     https://cloud.google.com/asset-inventory/docs/overview
+    # @!attribute [rw] api_short_name
+    #   @return [::String]
+    #     Used as a tracking tag when collecting data about the APIs developer
+    #     relations artifacts like docs, packages delivered to package managers,
+    #     etc.  Example: "speech".
+    # @!attribute [rw] github_label
+    #   @return [::String]
+    #     GitHub label to apply to issues and pull requests opened for this API.
+    # @!attribute [rw] codeowner_github_teams
+    #   @return [::Array<::String>]
+    #     GitHub teams to be added to CODEOWNERS in the directory in GitHub
+    #     containing source code for the client libraries for this API.
+    # @!attribute [rw] doc_tag_prefix
+    #   @return [::String]
+    #     A prefix used in sample code when demarking regions to be included in
+    #     documentation.
+    # @!attribute [rw] organization
+    #   @return [::Google::Api::ClientLibraryOrganization]
+    #     For whom the client library is being published.
+    # @!attribute [rw] library_settings
+    #   @return [::Array<::Google::Api::ClientLibrarySettings>]
+    #     Client library settings.  If the same version string appears multiple
+    #     times in this list, then the last one wins.  Settings from earlier
+    #     settings with the same version string are discarded.
+    class Publishing
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Java client libraries.
+    # @!attribute [rw] library_package
+    #   @return [::String]
+    #     The package name to use in Java. Clobbers the java_package option
+    #     set in the protobuf. This should be used **only** by APIs
+    #     who have already set the language_settings.java.package_name" field
+    #     in gapic.yaml. API teams should use the protobuf java_package option
+    #     where possible.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          library_package: com.google.cloud.pubsub.v1
+    # @!attribute [rw] service_class_names
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Configure the Java class name to use instead of the service's for its
+    #     corresponding generated GAPIC client. Keys are fully-qualified
+    #     service names as they appear in the protobuf (including the full
+    #     the language_settings.java.interface_names" field in gapic.yaml. API
+    #     teams should otherwise use the service name as it appears in the
+    #     protobuf.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          service_class_names:
+    #            - google.pubsub.v1.Publisher: TopicAdmin
+    #            - google.pubsub.v1.Subscriber: SubscriptionAdmin
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class JavaSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class ServiceClassNamesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # Settings for C++ client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class CppSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Php client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PhpSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Python client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PythonSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Node client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class NodeSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Dotnet client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class DotnetSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Ruby client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class RubySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Go client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class GoSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Describes the generator configuration for a method.
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     The fully qualified name of the method, for which the options below apply.
+    #     This is used to find the method to apply the options.
+    # @!attribute [rw] long_running
+    #   @return [::Google::Api::MethodSettings::LongRunning]
+    #     Describes settings to use for long-running operations when generating
+    #     API methods for RPCs. Complements RPCs that use the annotations in
+    #     google/longrunning/operations.proto.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        method_behavior:
+    #          - selector: CreateAdDomain
+    #            long_running:
+    #              initial_poll_delay:
+    #                seconds: 60 # 1 minute
+    #              poll_delay_multiplier: 1.5
+    #              max_poll_delay:
+    #                seconds: 360 # 6 minutes
+    #              total_poll_timeout:
+    #                 seconds: 54000 # 90 minutes
+    class MethodSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Describes settings to use when generating API methods that use the
+      # long-running operation pattern.
+      # All default values below are from those used in the client library
+      # generators (e.g.
+      # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
+      # @!attribute [rw] initial_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Initial delay after which the first poll request will be made.
+      #     Default value: 5 seconds.
+      # @!attribute [rw] poll_delay_multiplier
+      #   @return [::Float]
+      #     Multiplier to gradually increase delay between subsequent polls until it
+      #     reaches max_poll_delay.
+      #     Default value: 1.5.
+      # @!attribute [rw] max_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Maximum time between two subsequent poll requests.
+      #     Default value: 45 seconds.
+      # @!attribute [rw] total_poll_timeout
+      #   @return [::Google::Protobuf::Duration]
+      #     Total polling timeout.
+      #     Default value: 5 minutes.
+      class LongRunning
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # The organization for which the client libraries are being published.
+    # Affects the url where generated docs are published, etc.
+    module ClientLibraryOrganization
+      # Not useful.
+      CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
+
+      # Google Cloud Platform Org.
+      CLOUD = 1
+
+      # Ads (Advertising) Org.
+      ADS = 2
+
+      # Photos Org.
+      PHOTOS = 3
+
+      # Street View Org.
+      STREET_VIEW = 4
+    end
+
+    # To where should client libraries be published?
+    module ClientLibraryDestination
+      # Client libraries will neither be generated nor published to package
+      # managers.
+      CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
+
+      # Generate the client library in a repo under github.com/googleapis,
+      # but don't publish it to package managers.
+      GITHUB = 10
+
+      # Publish the library to package managers like nuget.org and npmjs.com.
+      PACKAGE_MANAGER = 20
+    end
+  end
+end

data/proto_docs/google/api/launch_stage.rb

@@ -20,7 +20,7 @@
 module Google
   module Api
     # The launch stage as defined by [Google Cloud Platform
-    # Launch Stages](http://cloud.google.com/terms/launch-stages).
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
     module LaunchStage
       # Do not use this default value.
       LAUNCH_STAGE_UNSPECIFIED = 0
@@ -42,7 +42,7 @@ module Google
       # 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 allowlisted. Alpha releases don’t have to be feature complete,
+      # projects allowlisted. 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
@@ -61,7 +61,7 @@ module Google
       GA = 4
 
       # Deprecated features are scheduled to be shut down and removed. For more
-      # information, see the “Deprecation Policy” section of our [Terms of
+      # 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.

data/proto_docs/google/api/monitored_resource.rb

@@ -40,6 +40,10 @@ module Google
     #   @return [::String]
     #     Required. The monitored resource type. For example, the type
     #     `"cloudsql_database"` represents databases in Google Cloud SQL.
+    #      For a list of types, see [Monitoring resource
+    #      types](https://cloud.google.com/monitoring/api/resources)
+    #     and [Logging resource
+    #     types](https://cloud.google.com/logging/docs/api/v2/resource-list).
     # @!attribute [rw] display_name
     #   @return [::String]
     #     Optional. A concise name for the monitored resource type that might be
@@ -71,16 +75,19 @@ module Google
     # 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"`:
+    # `"project_id"`, `"instance_id"` and `"zone"`:
     #
     #     { "type": "gce_instance",
-    #       "labels": { "instance_id": "12345678901234",
+    #       "labels": { "project_id": "my-project",
+    #                   "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`.
+    #     Some descriptors include the service name in the type; for example,
+    #     the type of a Datastream stream is `datastream.googleapis.com/Stream`.
     # @!attribute [rw] labels
     #   @return [::Google::Protobuf::Map{::String => ::String}]
     #     Required. Values for all of the labels listed in the associated monitored

data/proto_docs/google/monitoring/v3/alert.rb

@@ -32,7 +32,7 @@ module Google
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
         #
-        #     `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
+        #     `[ALERT_POLICY_ID]` is assigned by Cloud Monitoring when the policy
         #     is created. When calling the
         #     {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client#create_alert_policy alertPolicies.create}
         #     method, do not include the `name` field in the alerting policy passed as
@@ -118,7 +118,8 @@ module Google
           #     The text of the documentation, interpreted according to `mime_type`.
           #     The content may not exceed 8,192 Unicode characters and may not exceed
           #     more than 10,240 bytes when encoded in UTF-8 format, whichever is
-          #     smaller.
+          #     smaller. This text can be [templatized by using
+          #     variables](https://cloud.google.com/monitoring/alerts/doc-variables).
           # @!attribute [rw] mime_type
           #   @return [::String]
           #     The format of the `content` field. Presently, only the value
@@ -139,13 +140,13 @@ module Google
           #
           #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
           #
-          #     `[CONDITION_ID]` is assigned by Stackdriver Monitoring when the
+          #     `[CONDITION_ID]` is assigned by Cloud Monitoring when the
           #     condition is created as part of a new or updated alerting policy.
           #
           #     When calling the
           #     {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client#create_alert_policy alertPolicies.create}
           #     method, do not include the `name` field in the conditions of the
-          #     requested alerting policy. Stackdriver Monitoring creates the
+          #     requested alerting policy. Cloud Monitoring creates the
           #     condition identifiers and includes them in the new policy.
           #
           #     When calling the
@@ -279,6 +280,10 @@ module Google
             #     time series that have been identified by `filter` and `aggregations`,
             #     or by the ratio, if `denominator_filter` and `denominator_aggregations`
             #     are specified.
+            # @!attribute [rw] evaluation_missing_data
+            #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData]
+            #     A condition control that determines how metric-threshold conditions
+            #     are evaluated when data stops arriving.
             class MetricThreshold
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -396,10 +401,34 @@ module Google
             #     time series that have been identified by `filter` and `aggregations`,
             #     or by the ratio, if `denominator_filter` and `denominator_aggregations`
             #     are specified.
+            # @!attribute [rw] evaluation_missing_data
+            #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData]
+            #     A condition control that determines how metric-threshold conditions
+            #     are evaluated when data stops arriving.
             class MonitoringQueryLanguageCondition
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # A condition control that determines how metric-threshold conditions
+            # are evaluated when data stops arriving.
+            # This control doesn't affect metric-absence policies.
+            module EvaluationMissingData
+              # An unspecified evaluation missing data option.  Equivalent to
+              # EVALUATION_MISSING_DATA_NO_OP.
+              EVALUATION_MISSING_DATA_UNSPECIFIED = 0
+
+              # If there is no data to evaluate the condition, then evaluate the
+              # condition as false.
+              EVALUATION_MISSING_DATA_INACTIVE = 1
+
+              # If there is no data to evaluate the condition, then evaluate the
+              # condition as true.
+              EVALUATION_MISSING_DATA_ACTIVE = 2
+
+              # Do not evaluate the condition to any value if there is no data.
+              EVALUATION_MISSING_DATA_NO_OP = 3
+            end
           end
 
           # Control over how the notification channels in `notification_channels`

data/proto_docs/google/monitoring/v3/alert_service.rb

@@ -31,7 +31,7 @@ module Google
         #
         #     Note that this field names the parent container in which the alerting
         #     policy will be written, not the name of the created policy. |name| must be
-        #     a host project of a workspace, otherwise INVALID_ARGUMENT error will
+        #     a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will
         #     return. The alerting policy that is returned will have a name that contains
         #     a normalized representation of this name as a prefix but adds a suffix of
         #     the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the

data/proto_docs/google/monitoring/v3/snooze.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Monitoring
+      module V3
+        # A `Snooze` will prevent any alerts from being opened, and close any that
+        # are already open. The `Snooze` will work on alerts that match the
+        # criteria defined in the `Snooze`. The `Snooze` will be active from
+        # `interval.start_time` through `interval.end_time`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the `Snooze`. The format is:
+        #
+        #         projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
+        #
+        #     The ID of the `Snooze` will be generated by the system.
+        # @!attribute [rw] criteria
+        #   @return [::Google::Cloud::Monitoring::V3::Snooze::Criteria]
+        #     Required. This defines the criteria for applying the `Snooze`. See
+        #     `Criteria` for more information.
+        # @!attribute [rw] interval
+        #   @return [::Google::Cloud::Monitoring::V3::TimeInterval]
+        #     Required. The `Snooze` will be active from `interval.start_time` through
+        #     `interval.end_time`.
+        #     `interval.start_time` cannot be in the past. There is a 15 second clock
+        #     skew to account for the time it takes for a request to reach the API from
+        #     the UI.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. A display name for the `Snooze`. This can be, at most, 512
+        #     unicode characters.
+        class Snooze
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
+          # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
+          # whose names are supplied.
+          # @!attribute [rw] policies
+          #   @return [::Array<::String>]
+          #     The specific `AlertPolicy` names for the alert that should be snoozed.
+          #     The format is:
+          #
+          #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]
+          #
+          #     There is a limit of 10 policies per snooze. This limit is checked during
+          #     snooze creation.
+          class Criteria
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end