google-apis-monitoring_v3 0.33.0 → 0.64.0

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

@@ -32,6 +32,8 @@ module Google
       #
       # @see https://cloud.google.com/monitoring/api/
       class MonitoringService < Google::Apis::Core::BaseService
+        DEFAULT_ENDPOINT_TEMPLATE = "https://monitoring.$UNIVERSE_DOMAIN$/"
+
         # @return [String]
         #  API key. Your API key identifies your project and provides you with API access,
         #  quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -43,7 +45,7 @@ module Google
         attr_accessor :quota_user
 
         def initialize
-          super('https://monitoring.googleapis.com/', '',
+          super(DEFAULT_ENDPOINT_TEMPLATE, '',
                 client_name: 'google-apis-monitoring_v3',
                 client_version: Google::Apis::MonitoringV3::GEM_VERSION)
           @batch_path = 'batch'
@@ -377,7 +379,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a new alerting policy.
+        # Creates a new alerting policy.Design your application to single-thread API
+        # calls that modify the state of alerting policies in a single project. This
+        # includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
         # @param [String] name
         #   Required. The project (https://cloud.google.com/monitoring/api/v3#project_name)
         #   in which to create the alerting policy. The format is: projects/[
@@ -418,7 +422,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes an alerting policy.
+        # Deletes an alerting policy.Design your application to single-thread API calls
+        # that modify the state of alerting policies in a single project. This includes
+        # calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
         # @param [String] name
         #   Required. The alerting policy to delete. The format is: projects/[
         #   PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information,
@@ -538,7 +544,9 @@ module Google
         # Updates an alerting policy. You can either replace the entire policy with a
         # new one or replace only certain fields in the current alerting policy by
         # specifying the fields to be updated via updateMask. Returns the updated
-        # alerting policy.
+        # alerting policy.Design your application to single-thread API calls that modify
+        # 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] [
@@ -997,7 +1005,9 @@ module Google
         #   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.
+        #   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
@@ -1188,7 +1198,11 @@ module Google
         end
         
         # Creates a new notification channel, representing a single notification
-        # endpoint such as an email address, SMS number, or PagerDuty service.
+        # endpoint such as an email address, SMS number, or PagerDuty service.Design
+        # your application to single-thread API calls that modify the state of
+        # notification channels in a single project. This includes calls to
+        # CreateNotificationChannel, DeleteNotificationChannel and
+        # UpdateNotificationChannel.
         # @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/[
@@ -1226,7 +1240,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a notification channel.
+        # Deletes a notification channel.Design your application to single-thread API
+        # calls that modify the state of notification channels in a single project. This
+        # includes calls to CreateNotificationChannel, DeleteNotificationChannel and
+        # UpdateNotificationChannel.
         # @param [String] name
         #   Required. The channel for which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
@@ -1350,7 +1367,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists the notification channels that have been created for the project.
+        # Lists the notification channels that have been created for the project. To
+        # list the types of notification channels that are supported, use the
+        # ListNotificationChannelDescriptors method.
         # @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/[
@@ -1407,7 +1426,10 @@ module Google
         end
         
         # Updates a notification channel. Fields not specified in the field mask remain
-        # unchanged.
+        # unchanged.Design your application to single-thread API calls that modify the
+        # state of notification channels in a single project. This includes calls to
+        # 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
@@ -1513,9 +1535,178 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates a Snooze that will prevent alerts, which match the provided criteria,
+        # from being opened. The Snooze applies for a specific time interval.
+        # @param [String] parent
+        #   Required. The project (https://cloud.google.com/monitoring/api/v3#project_name)
+        #   in which a Snooze should be created. The format is: projects/[
+        #   PROJECT_ID_OR_NUMBER]
+        # @param [Google::Apis::MonitoringV3::Snooze] snooze_object
+        # @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::Snooze] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::Snooze]
+        #
+        # @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 create_project_snooze(parent, snooze_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v3/{+parent}/snoozes', options)
+          command.request_representation = Google::Apis::MonitoringV3::Snooze::Representation
+          command.request_object = snooze_object
+          command.response_representation = Google::Apis::MonitoringV3::Snooze::Representation
+          command.response_class = Google::Apis::MonitoringV3::Snooze
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieves a Snooze by name.
+        # @param [String] name
+        #   Required. The ID of the Snooze to retrieve. The format is: projects/[
+        #   PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
+        # @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::Snooze] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::Snooze]
+        #
+        # @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_snooze(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v3/{+name}', options)
+          command.response_representation = Google::Apis::MonitoringV3::Snooze::Representation
+          command.response_class = Google::Apis::MonitoringV3::Snooze
+          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 Snoozes associated with a project. Can optionally pass in filter,
+        # which specifies predicates to match Snoozes.
+        # @param [String] parent
+        #   Required. The project (https://cloud.google.com/monitoring/api/v3#project_name)
+        #   whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
+        #   
+        # @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" ```
+        # @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
+        #   single page. The value should be in the range 1, 1000. If the value given is
+        #   outside this range, the server will decide the number of results to be
+        #   returned.
+        # @param [String] page_token
+        #   Optional. The next_page_token from a previous call to ListSnoozesRequest to
+        #   get the next page 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::ListSnoozesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::ListSnoozesResponse]
+        #
+        # @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_snoozes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v3/{+parent}/snoozes', options)
+          command.response_representation = Google::Apis::MonitoringV3::ListSnoozesResponse::Representation
+          command.response_class = Google::Apis::MonitoringV3::ListSnoozesResponse
+          command.params['parent'] = parent unless parent.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?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates a Snooze, identified by its name, with the parameters in the given
+        # Snooze object.
+        # @param [String] name
+        #   Required. Identifier. 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.
+        # @param [Google::Apis::MonitoringV3::Snooze] snooze_object
+        # @param [String] update_mask
+        #   Required. The fields to update.For each field listed in update_mask: If the
+        #   Snooze object supplied in the UpdateSnoozeRequest has a value for that field,
+        #   the value of the field in the existing Snooze will be set to the value of the
+        #   field in the supplied Snooze. If the field does not have a value in the
+        #   supplied Snooze, the field in the existing Snooze is set to its default value.
+        #   Fields not listed retain their existing value.The following are the field
+        #   names that are accepted in update_mask: display_name interval.start_time
+        #   interval.end_timeThat said, the start time and end time of the Snooze
+        #   determines which fields can legally be updated. Before attempting an update,
+        #   users should consult the documentation for UpdateSnoozeRequest, which talks
+        #   about which fields can be updated.
+        # @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::Snooze] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::Snooze]
+        #
+        # @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 patch_project_snooze(name, snooze_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v3/{+name}', options)
+          command.request_representation = Google::Apis::MonitoringV3::Snooze::Representation
+          command.request_object = snooze_object
+          command.response_representation = Google::Apis::MonitoringV3::Snooze::Representation
+          command.response_class = Google::Apis::MonitoringV3::Snooze
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates or adds data to one or more time series. The response is empty if all
         # time series in the request were written. If any time series could not be
         # written, a corresponding failure message is included in the error response.
+        # This method does not support resource locations constraint of an organization
+        # policy (https://cloud.google.com/resource-manager/docs/organization-policy/
+        # defining-locations#setting_the_organization_policy).
         # @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/[
@@ -1943,10 +2134,10 @@ module Google
         # configuration by specifying the fields to be updated via updateMask. Returns
         # the updated configuration.
         # @param [String] name
-        #   A unique resource name for this Uptime check configuration. The format is:
-        #   projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [
-        #   PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime
-        #   check.This field should be omitted when creating the Uptime check
+        #   Identifier. A unique resource name for this Uptime check configuration. The
+        #   format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
+        #   [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the
+        #   Uptime check.This field should be omitted when creating the Uptime check
         #   configuration; on create, the resource name is assigned by the server and
         #   included in the response.
         # @param [Google::Apis::MonitoringV3::UptimeCheckConfig] uptime_check_config_object
@@ -2147,8 +2338,8 @@ module Google
         
         # Update this Service.
         # @param [String] name
-        #   Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/
-        #   services/[SERVICE_ID]
+        #   Identifier. Resource name for this Service. The format is: projects/[
+        #   PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
         # @param [Google::Apis::MonitoringV3::Service] service_object
         # @param [String] update_mask
         #   A set of field paths defining which fields to use for the update.
@@ -2189,7 +2380,8 @@ module Google
         # @param [Google::Apis::MonitoringV3::ServiceLevelObjective] service_level_objective_object
         # @param [String] service_level_objective_id
         #   Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective.
-        #   If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+
+        #   If omitted, an id will be generated instead. Must match the pattern ^[a-zA-Z0-
+        #   9-_:.]+$
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2343,8 +2535,9 @@ module Google
         
         # Update the given ServiceLevelObjective.
         # @param [String] name
-        #   Resource name for this ServiceLevelObjective. The format is: projects/[
-        #   PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
+        #   Identifier. Resource name for this ServiceLevelObjective. The format is:
+        #   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[
+        #   SLO_NAME]
         # @param [Google::Apis::MonitoringV3::ServiceLevelObjective] service_level_objective_object
         # @param [String] update_mask
         #   A set of field paths defining which fields to use for the update.
@@ -2378,7 +2571,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns the list of IP addresses that checkers run from
+        # Returns the list of IP addresses that checkers run from.
         # @param [Fixnum] page_size
         #   The maximum number of results to return in a single response. The server may
         #   further constrain the maximum number of results returned in a single page. If

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-monitoring_v3
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.64.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ 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.33.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-monitoring_v3/v0.64.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-monitoring_v3
 post_install_message: 
 rdoc_options: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Monitoring API V3