google-cloud-monitoring-v3 0.4.0 → 0.5.0

data/proto_docs/google/api/monitored_resource.rb

@@ -40,7 +40,6 @@ module Google
     #   @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
@@ -56,6 +55,9 @@ module Google
     #     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"`.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Optional. The launch stage of the monitored resource definition.
     class MonitoredResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -101,15 +103,14 @@ module Google
     # 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
+    # auxiliary metadata. Monitoring and Logging use an ingestion
+    # pipeline to extract metadata for cloud resources of all types, and store
     # 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",
+    #     System labels are a kind of metadata extracted by Google, including
+    #     "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:

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -33,7 +33,7 @@ module Google
         #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
         #
         #     `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
-        #     is created.  When calling the
+        #     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
         #     part of the request.
@@ -104,6 +104,9 @@ module Google
         #   @return [::Google::Cloud::Monitoring::V3::MutationRecord]
         #     A read-only record of the most recent change to the alerting policy. If
         #     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.
         class AlertPolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,6 +171,10 @@ module Google
           #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricAbsence]
           #     A condition that checks that a time series continues to
           #     receive new data points.
+          # @!attribute [rw] condition_matched_log
+          #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::LogMatch]
+          #     A condition that checks for log messages matching given constraints. If
+          #     set, no other conditions can be present.
           # @!attribute [rw] condition_monitoring_query_language
           #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MonitoringQueryLanguageCondition]
           #     A condition that uses the Monitoring Query Language to define
@@ -327,6 +334,42 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # A condition type that checks whether a log message in the [scoping
+            # project](https://cloud.google.com/monitoring/api/v3#project_name)
+            # satisfies the given filter. Logs from other projects in the metrics
+            # scope are not evaluated.
+            # @!attribute [rw] filter
+            #   @return [::String]
+            #     Required. A logs-based filter. See [Advanced Logs
+            #     Queries](/logging/docs/view/advanced-queries) for how this filter
+            #     should be constructed.
+            # @!attribute [rw] label_extractors
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     Optional. A map from a label key to an extractor expression, which is
+            #     used to extract the value for this label key. Each entry in this map is
+            #     a specification for how data should be extracted from log entries that
+            #     match `filter`. Each combination of extracted values is treated as a
+            #     separate rule for the purposes of triggering notifications. Label keys
+            #     and corresponding values can be used in notifications generated by this
+            #     condition.
+            #
+            #     Please see [the documentation on logs-based metric
+            #     `valueExtractor`s](/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor)
+            #     for syntax and examples.
+            class LogMatch
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class LabelExtractorsEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
             # A condition type that allows alert policies to be defined using
             # [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
             # @!attribute [rw] query
@@ -359,6 +402,28 @@ module Google
             end
           end
 
+          # Control over how the notification channels in `notification_channels`
+          # 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.
+          #
+          #     This limit is not implemented for alert policies that are not log-based.
+          class AlertStrategy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Control over the rate of notifications sent to this alert policy's
+            # notification channels.
+            # @!attribute [rw] period
+            #   @return [::Google::Protobuf::Duration]
+            #     Not more than one notification per `period`.
+            class NotificationRateLimit
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value

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

@@ -24,7 +24,8 @@ module Google
         # The protocol for the `CreateAlertPolicy` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project in which to create the alerting policy. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
+        #     which to create the alerting policy. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         #
@@ -59,7 +60,8 @@ module Google
         # The protocol for the `ListAlertPolicies` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project whose alert policies are to be listed. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
+        #     whose alert policies are to be listed. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         #

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

@@ -44,7 +44,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.
+        # A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.
         #
         # * For `GAUGE` metrics, the `startTime` value is technically optional; if
         #   no value is specified, the start time defaults to the value of the
@@ -459,18 +459,6 @@ module Google
           # True if the left argument is not equal to the right argument.
           COMPARISON_NE = 6
         end
-
-        # Obsolete.
-        module ServiceTier
-          # Obsolete.
-          SERVICE_TIER_UNSPECIFIED = 0
-
-          # Obsolete.
-          SERVICE_TIER_BASIC = 1
-
-          # Obsolete.
-          SERVICE_TIER_PREMIUM = 2
-        end
       end
     end
   end

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

@@ -24,7 +24,8 @@ module Google
         # The `ListGroup` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project whose groups are to be listed. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
+        #     whose groups are to be listed. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] children_of_group
@@ -95,7 +96,8 @@ module Google
         # The `CreateGroup` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project in which to create the group. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
+        #     which to create the group. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] group

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

@@ -52,7 +52,9 @@ module Google
         # @!attribute [rw] resource
         #   @return [::Google::Api::MonitoredResource]
         #     The associated monitored resource.  Custom metrics can use only certain
-        #     monitored resource types in their time series data.
+        #     monitored resource types in their time series data. For more information,
+        #     see [Monitored resources for custom
+        #     metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
         # @!attribute [rw] metadata
         #   @return [::Google::Api::MonitoredResourceMetadata]
         #     Output only. The associated monitored resource metadata. When reading a

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

@@ -24,7 +24,8 @@ module Google
         # The `ListMonitoredResourceDescriptors` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+        #     which to execute the request. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] filter
@@ -80,7 +81,8 @@ module Google
         # The `ListMetricDescriptors` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+        #     which to execute the request. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] filter
@@ -138,8 +140,9 @@ module Google
         # The `CreateMetricDescriptor` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
-        #
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+        #     which to execute the request. The format is:
+        #     4
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] metric_descriptor
         #   @return [::Google::Api::MetricDescriptor]
@@ -167,8 +170,8 @@ module Google
         # The `ListTimeSeries` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project, organization or folder on which to execute the request. The
-        #     format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name),
+        #     organization or folder on which to execute the request. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         #         organizations/[ORGANIZATION_ID]
@@ -262,7 +265,8 @@ module Google
         # The `CreateTimeSeries` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+        #     which to execute the request. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] time_series
@@ -321,7 +325,8 @@ module Google
         # The `QueryTimeSeries` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
+        #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+        #     which to execute the request. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] query

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

@@ -52,10 +52,6 @@ module Google
         #     The set of labels that must be defined to identify a particular
         #     channel of the corresponding type. Each label includes a
         #     description for how that field should be populated.
-        # @!attribute [rw] supported_tiers
-        #   @return [::Array<::Google::Cloud::Monitoring::V3::ServiceTier>]
-        #     The tiers that support this notification channel; the project service tier
-        #     must be one of the supported_tiers.
         # @!attribute [rw] launch_stage
         #   @return [::Google::Api::LaunchStage]
         #     The product launch stage for channels of this type.