google-cloud-monitoring-v3 1.0.1 → 1.2.0

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

@@ -23,12 +23,12 @@ module Google
       module V3
         # A description of the conditions under which some aspect of your system is
         # considered to be "unhealthy" and the ways to notify people or services about
-        # this state. For an overview of alert policies, see
+        # this state. For an overview of alerting policies, see
         # [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required if the policy exists. The resource name for this policy. The
-        #     format is:
+        #     Identifier. Required if the policy exists. The resource name for this
+        #     policy. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
         #
@@ -97,9 +97,9 @@ module Google
         #     a field projection has been specified that strips it out.
         # @!attribute [rw] validity
         #   @return [::Google::Rpc::Status]
-        #     Read-only description of how the alert policy is invalid. This field is
-        #     only set when the alert policy is invalid. An invalid alert policy will not
-        #     generate incidents.
+        #     Read-only description of how the alerting policy is invalid. This field is
+        #     only set when the alerting policy is invalid. An invalid alerting policy
+        #     will not generate incidents.
         # @!attribute [rw] notification_channels
         #   @return [::Array<::String>]
         #     Identifies the notification channels to which notifications should be sent
@@ -122,12 +122,12 @@ module Google
         #     provided in a call to create or update, this field will be ignored.
         # @!attribute [rw] alert_strategy
         #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy]
-        #     Control over how this alert policy's notification channels are notified.
+        #     Control over how this alerting policy's notification channels are notified.
         # @!attribute [rw] severity
         #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Severity]
-        #     Optional. The severity of an alert policy indicates how important incidents
-        #     generated by that policy are. The severity level will be displayed on the
-        #     Incident detail page and in notifications.
+        #     Optional. The severity of an alerting policy indicates how important
+        #     incidents generated by that policy are. The severity level will be
+        #     displayed on the Incident detail page and in notifications.
         class AlertPolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -140,7 +140,7 @@ module Google
           #     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. This text can be [templatized by using
-          #     variables](https://cloud.google.com/monitoring/alerts/doc-variables).
+          #     variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
           # @!attribute [rw] mime_type
           #   @return [::String]
           #     The format of the `content` field. Presently, only the value
@@ -158,7 +158,7 @@ module Google
           #     it is common to define textual fields in databases as VARCHAR(255).
           #
           #     The contents of the subject line can be [templatized by using
-          #     variables](https://cloud.google.com/monitoring/alerts/doc-variables).
+          #     variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
           #     If this field is missing or empty, a default subject line will be
           #     generated.
           # @!attribute [rw] links
@@ -460,7 +460,7 @@ module Google
               end
             end
 
-            # A condition type that allows alert policies to be defined using
+            # A condition type that allows alerting policies to be defined using
             # [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
             # @!attribute [rw] query
             #   @return [::String]
@@ -495,7 +495,7 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # A condition type that allows alert policies to be defined using
+            # A condition type that allows alerting policies to be defined using
             # [Prometheus Query Language
             # (PromQL)](https://prometheus.io/docs/prometheus/latest/querying/basics/).
             #
@@ -553,7 +553,7 @@ module Google
             #     Label names [must be
             #     valid](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
             #     Label values can be [templatized by using
-            #     variables](https://cloud.google.com/monitoring/alerts/doc-variables).
+            #     variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
             #     The only available variable names are the names of the labels in the
             #     PromQL result, including "__name__" and "value". "labels" may be empty.
             # @!attribute [rw] rule_group
@@ -624,12 +624,19 @@ module Google
           # are notified when this alert fires.
           # @!attribute [rw] notification_rate_limit
           #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationRateLimit]
-          #     Required for alert policies with a `LogMatch` condition.
+          #     Required for log-based alerting policies, i.e. policies with a `LogMatch`
+          #     condition.
           #
-          #     This limit is not implemented for alert policies that are not log-based.
+          #     This limit is not implemented for alerting policies that do not have
+          #     a LogMatch condition.
+          # @!attribute [rw] notification_prompts
+          #   @return [::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationPrompt>]
+          #     For log-based alert policies, the notification prompts is always
+          #     [OPENED]. For non log-based alert policies, the notification prompts can
+          #     be [OPENED] or [OPENED, CLOSED].
           # @!attribute [rw] auto_close
           #   @return [::Google::Protobuf::Duration]
-          #     If an alert policy that was active has no data for this long, any open
+          #     If an alerting policy that was active has no data for this long, any open
           #     incidents will close
           # @!attribute [rw] notification_channel_strategy
           #   @return [::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationChannelStrategy>]
@@ -638,7 +645,7 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
-            # Control over the rate of notifications sent to this alert policy's
+            # Control over the rate of notifications sent to this alerting policy's
             # notification channels.
             # @!attribute [rw] period
             #   @return [::Google::Protobuf::Duration]
@@ -667,6 +674,18 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Control when notifications will be sent out.
+            module NotificationPrompt
+              # No strategy specified. Treated as error.
+              NOTIFICATION_PROMPT_UNSPECIFIED = 0
+
+              # Notify when an incident is opened.
+              OPENED = 1
+
+              # Notify when an incident is closed.
+              CLOSED = 3
+            end
           end
 
           # @!attribute [rw] key
@@ -699,7 +718,7 @@ module Google
             AND_WITH_MATCHING_RESOURCE = 3
           end
 
-          # An enumeration of possible severity level for an Alert Policy.
+          # An enumeration of possible severity level for an alerting policy.
           module Severity
             # No severity is specified. This is the default value.
             SEVERITY_UNSPECIFIED = 0

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

@@ -74,27 +74,28 @@ module Google
         #     operation, instead.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     If provided, this field specifies the criteria that must be met by
-        #     alert policies to be included in the response.
+        #     Optional. If provided, this field specifies the criteria that must be met
+        #     by alert policies to be included in the response.
         #
         #     For more details, see [sorting and
         #     filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
         # @!attribute [rw] order_by
         #   @return [::String]
-        #     A comma-separated list of fields by which to sort the result. Supports
-        #     the same set of field references as the `filter` field. Entries can be
-        #     prefixed with a minus sign to sort by the field in descending order.
+        #     Optional. A comma-separated list of fields by which to sort the result.
+        #     Supports the same set of field references as the `filter` field. Entries
+        #     can be prefixed with a minus sign to sort by the field in descending order.
         #
         #     For more details, see [sorting and
         #     filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     The maximum number of results to return in a single response.
+        #     Optional. The maximum number of results to return in a single response.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     If this field is not empty then it must contain the `nextPageToken` value
-        #     returned by a previous call to this method.  Using this field causes the
-        #     method to return more results from the previous method call.
+        #     Optional. If this field is not empty then it must contain the
+        #     `nextPageToken` value returned by a previous call to this method.  Using
+        #     this field causes the method to return more results from the previous
+        #     method call.
         class ListAlertPoliciesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -78,7 +78,7 @@ module Google
         #     field.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The full REST resource name for this channel. The format is:
+        #     Identifier. The full REST resource name for this channel. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
         #

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

@@ -115,27 +115,27 @@ module Google
         #     operation.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     If provided, this field specifies the criteria that must be met by
-        #     notification channels to be included in the response.
+        #     Optional. If provided, this field specifies the criteria that must be met
+        #     by notification channels to be included in the response.
         #
         #     For more details, see [sorting and
         #     filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
         # @!attribute [rw] order_by
         #   @return [::String]
-        #     A comma-separated list of fields by which to sort the result. Supports
-        #     the same set of fields as in `filter`. Entries can be prefixed with
-        #     a minus sign to sort in descending rather than ascending order.
+        #     Optional. A comma-separated list of fields by which to sort the result.
+        #     Supports the same set of fields as in `filter`. Entries can be prefixed
+        #     with a minus sign to sort in descending rather than ascending order.
         #
         #     For more details, see [sorting and
         #     filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     The maximum number of results to return in a single response. If
+        #     Optional. The maximum number of results to return in a single response. If
         #     not set to a positive number, a reasonable value will be chosen by the
         #     service.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     If non-empty, `page_token` must contain a value returned as the
+        #     Optional. If non-empty, `page_token` must contain a value returned as the
         #     `next_page_token` in a previous response to request the next set
         #     of results.
         class ListNotificationChannelsRequest
@@ -176,7 +176,7 @@ module Google
         # The `UpdateNotificationChannel` request.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     The fields to update.
+        #     Optional. The fields to update.
         # @!attribute [rw] notification_channel
         #   @return [::Google::Cloud::Monitoring::V3::NotificationChannel]
         #     Required. A description of the changes to be applied to the specified
@@ -198,8 +198,8 @@ module Google
         #   @return [::Boolean]
         #     If true, the notification channel will be deleted regardless of its
         #     use in alert policies (the policies will be updated to remove the
-        #     channel). If false, channels that are still referenced by an existing
-        #     alerting policy will fail to be deleted in a delete operation.
+        #     channel). If false, this operation will fail if the notification channel
+        #     is referenced by existing alerting policies.
         class DeleteNotificationChannelRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -27,7 +27,7 @@ module Google
         # `interval.start_time` through `interval.end_time`.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the `Snooze`. The format is:
+        #     Required. Identifier. The name of the `Snooze`. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
         #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-v3
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Manages your Cloud Monitoring data and configurations.