google-apis-monitoring_v3 0.64.0 → 0.83.0

data/lib/google/apis/monitoring_v3/service.rb

@@ -495,21 +495,22 @@ module Google
         #   the alerting policies to be listed are stored. To retrieve a single alerting
         #   policy by name, use the GetAlertPolicy operation, instead.
         # @param [String] filter
-        #   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).
-        # @param [String] order_by
-        #   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-
+        #   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).
+        # @param [String] order_by
+        #   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).
         # @param [Fixnum] page_size
-        #   The maximum number of results to return in a single response.
+        #   Optional. The maximum number of results to return in a single response.
         # @param [String] page_token
-        #   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.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -548,9 +549,9 @@ module Google
         # the state of alerting policies in a single project. This includes calls to
         # CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
         # @param [String] name
-        #   Required if the policy exists. The resource name for this policy. The format
-        #   is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [
-        #   ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created.
+        #   Identifier. Required if the policy exists. The resource name for this policy.
+        #   The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
+        #   [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created.
         #   When calling the alertPolicies.create method, do not include the name field in
         #   the alerting policy passed as part of the request.
         # @param [Google::Apis::MonitoringV3::AlertPolicy] alert_policy_object
@@ -600,6 +601,89 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets a single alert.
+        # @param [String] name
+        #   Required. The name of the alert.The format is: projects/[PROJECT_ID_OR_NUMBER]/
+        #   alerts/[ALERT_ID] The [ALERT_ID] is a system-assigned unique identifier for
+        #   the alert.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::MonitoringV3::Alert] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::Alert]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_alert(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v3/{+name}', options)
+          command.response_representation = Google::Apis::MonitoringV3::Alert::Representation
+          command.response_class = Google::Apis::MonitoringV3::Alert
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists the existing alerts for the metrics scope of the project.
+        # @param [String] parent
+        #   Required. The name of the project to list alerts for.
+        # @param [String] filter
+        #   Optional. An alert is returned if there is a match on any fields belonging to
+        #   the alert or its subfields.
+        # @param [String] order_by
+        #   Optional. A comma-separated list of fields in Alert to use for sorting. The
+        #   default sort direction is ascending. To specify descending order for a field,
+        #   add a desc modifier. The following fields are supported: open_time
+        #   close_timeFor example, close_time desc, open_time will return the alerts
+        #   closed most recently, with ties broken in the order of older alerts listed
+        #   first.If the field is not set, the results are sorted by open_time desc.
+        # @param [Fixnum] page_size
+        #   Optional. The maximum number of results to return in a single response. If not
+        #   set to a positive number, at most 50 alerts will be returned. The maximum
+        #   value is 1000; values above 1000 will be coerced to 1000.
+        # @param [String] page_token
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::MonitoringV3::ListAlertsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::ListAlertsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_alerts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v3/{+parent}/alerts', options)
+          command.response_representation = Google::Apis::MonitoringV3::ListAlertsResponse::Representation
+          command.response_class = Google::Apis::MonitoringV3::ListAlertsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Cloud Monitoring Agent only: Creates a new time series.This method is only for
         # use by the Cloud Monitoring Agent. Use projects.timeSeries.create instead.
         # @param [String] name
@@ -997,21 +1081,31 @@ module Google
         #   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]
+        # @param [Boolean] active_only
+        #   Optional. If true, only metrics and monitored resource types that have recent
+        #   data (within roughly 25 hours) will be included in the response. - If a metric
+        #   descriptor enumerates monitored resource types, only the monitored resource
+        #   types for which the metric type has recent data will be included in the
+        #   returned metric descriptor, and if none of them have recent data, the metric
+        #   descriptor will not be returned. - If a metric descriptor does not enumerate
+        #   the compatible monitored resource types, it will be returned only if the
+        #   metric type has recent data for some monitored resource type. The returned
+        #   descriptor will not enumerate any monitored resource types.
         # @param [String] filter
-        #   If this field is empty, all custom and system-defined metric descriptors are
-        #   returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/
-        #   filters) specifies which metric descriptors are to be returned. For example,
-        #   the following filter matches all custom metrics (https://cloud.google.com/
-        #   monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/")
-        #   
+        #   Optional. If this field is empty, all custom and system-defined metric
+        #   descriptors are returned. Otherwise, the filter (https://cloud.google.com/
+        #   monitoring/api/v3/filters) specifies which metric descriptors are to be
+        #   returned. For example, the following filter matches all custom metrics (https:/
+        #   /cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("
+        #   custom.googleapis.com/")
         # @param [Fixnum] page_size
-        #   A positive number that is the maximum number of results to return. The default
-        #   and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted,
-        #   will instead return a maximum of 10,000 results.
+        #   Optional. A positive number that is the maximum number of results to return.
+        #   The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is
+        #   submitted, will instead return a maximum of 10,000 results.
         # @param [String] page_token
-        #   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 additional 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 additional results from the previous method call.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1029,11 +1123,12 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def list_project_metric_descriptors(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def list_project_metric_descriptors(name, active_only: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v3/{+name}/metricDescriptors', options)
           command.response_representation = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse::Representation
           command.response_class = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse
           command.params['name'] = name unless name.nil?
+          command.query['activeOnly'] = active_only unless active_only.nil?
           command.query['filter'] = filter unless filter.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
           command.query['pageToken'] = page_token unless page_token.nil?
@@ -1250,8 +1345,8 @@ module Google
         # @param [Boolean] force
         #   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.
+        #   this operation will fail if the notification channel is referenced by existing
+        #   alerting policies.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1378,22 +1473,22 @@ module Google
         #   specific channel by REST resource name, use the GetNotificationChannel
         #   operation.
         # @param [String] filter
-        #   If provided, this field specifies the criteria that must be met by
+        #   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).
         # @param [String] order_by
-        #   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).
+        #   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).
         # @param [Fixnum] page_size
-        #   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.
+        #   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.
         # @param [String] page_token
-        #   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.
+        #   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.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1431,12 +1526,12 @@ module Google
         # CreateNotificationChannel, DeleteNotificationChannel and
         # UpdateNotificationChannel.
         # @param [String] name
-        #   The full REST resource name for this channel. The format is: projects/[
-        #   PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is
-        #   automatically assigned by the server on creation.
+        #   Identifier. The full REST resource name for this channel. The format is:
+        #   projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [
+        #   CHANNEL_ID] is automatically assigned by the server on creation.
         # @param [Google::Apis::MonitoringV3::NotificationChannel] notification_channel_object
         # @param [String] update_mask
-        #   The fields to update.
+        #   Optional. The fields to update.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1611,8 +1706,8 @@ module Google
         # @param [String] filter
         #   Optional. Optional filter to restrict results to the given criteria. The
         #   following fields are supported. interval.start_time interval.end_timeFor
-        #   example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.
-        #   end_time < "2022-03-12T00:00:00-08:00" ```
+        #   example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.
+        #   end_time < "2022-03-12T00:00:00-08:00"
         # @param [Fixnum] page_size
         #   Optional. The maximum number of results to return for a single query. The
         #   server may further constrain the maximum number of results returned in a
@@ -1945,7 +2040,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Queries time series using Monitoring Query Language.
+        # Queries time series by using Monitoring Query Language (MQL). We recommend
+        # using PromQL instead of MQL. For more information about the status of MQL, see
+        # the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/
+        # deprecations/mql).
         # @param [String] name
         #   Required. The project (https://cloud.google.com/monitoring/api/v3#project_name)
         #   on which to execute the request. The format is: projects/[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-monitoring_v3
 version: !ruby/object:Gem::Version
-  version: 0.64.0
+  version: 0.83.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,9 +57,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-monitoring_v3/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-monitoring_v3/v0.64.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-monitoring_v3/v0.83.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-monitoring_v3
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -68,15 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple REST client for Cloud Monitoring API V3
 test_files: []