google-cloud-monitoring-v3 0.9.0 → 0.11.0

data/lib/google/cloud/monitoring/v3/snooze_service/credentials.rb

@@ -0,0 +1,53 @@
+# 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!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        module SnoozeService
+          # Credentials for the SnoozeService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/monitoring",
+              "https://www.googleapis.com/auth/monitoring.read"
+            ]
+            self.env_vars = [
+              "MONITORING_CREDENTIALS",
+              "MONITORING_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "MONITORING_CREDENTIALS_JSON",
+              "MONITORING_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/monitoring/v3/snooze_service/paths.rb

@@ -0,0 +1,149 @@
+# 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
+        module SnoozeService
+          # Path helper methods for the SnoozeService API.
+          module Paths
+            ##
+            # Create a fully-qualified AlertPolicy resource string.
+            #
+            # @overload alert_policy_path(project:, alert_policy:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/alertPolicies/{alert_policy}`
+            #
+            #   @param project [String]
+            #   @param alert_policy [String]
+            #
+            # @overload alert_policy_path(organization:, alert_policy:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/alertPolicies/{alert_policy}`
+            #
+            #   @param organization [String]
+            #   @param alert_policy [String]
+            #
+            # @overload alert_policy_path(folder:, alert_policy:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/alertPolicies/{alert_policy}`
+            #
+            #   @param folder [String]
+            #   @param alert_policy [String]
+            #
+            # @return [::String]
+            def alert_policy_path **args
+              resources = {
+                "alert_policy:project" => (proc do |project:, alert_policy:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/alertPolicies/#{alert_policy}"
+                end),
+                "alert_policy:organization" => (proc do |organization:, alert_policy:|
+                  raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
+
+                  "organizations/#{organization}/alertPolicies/#{alert_policy}"
+                end),
+                "alert_policy:folder" => (proc do |folder:, alert_policy:|
+                  raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
+
+                  "folders/#{folder}/alertPolicies/#{alert_policy}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            ##
+            # Create a fully-qualified Project resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}`
+            #
+            # @param project [String]
+            #
+            # @return [::String]
+            def project_path project:
+              "projects/#{project}"
+            end
+
+            ##
+            # Create a fully-qualified Snooze resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/snoozes/{snooze}`
+            #
+            # @param project [String]
+            # @param snooze [String]
+            #
+            # @return [::String]
+            def snooze_path project:, snooze:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/snoozes/#{snooze}"
+            end
+
+            ##
+            # Create a fully-qualified Workspace resource string.
+            #
+            # @overload workspace_path(project:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}`
+            #
+            #   @param project [String]
+            #
+            # @overload workspace_path(workspace:)
+            #   The resource will be in the following format:
+            #
+            #   `workspaces/{workspace}`
+            #
+            #   @param workspace [String]
+            #
+            # @return [::String]
+            def workspace_path **args
+              resources = {
+                "project" => (proc do |project:|
+                  "projects/#{project}"
+                end),
+                "workspace" => (proc do |workspace:|
+                  "workspaces/#{workspace}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/monitoring/v3/snooze_service.rb

@@ -0,0 +1,51 @@
+# 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/monitoring/v3/version"
+
+require "google/cloud/monitoring/v3/snooze_service/credentials"
+require "google/cloud/monitoring/v3/snooze_service/paths"
+require "google/cloud/monitoring/v3/snooze_service/client"
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        ##
+        # The SnoozeService API is used to temporarily prevent an alert policy from
+        # generating alerts. A Snooze is a description of the criteria under which one
+        # or more alert policies should not fire alerts for the specified duration.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/monitoring/v3/snooze_service"
+        #     client = ::Google::Cloud::Monitoring::V3::SnoozeService::Client.new
+        #
+        module SnoozeService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "snooze_service", "helpers.rb"
+require "google/cloud/monitoring/v3/snooze_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/monitoring/v3/uptime_check_service/client.rb

@@ -28,13 +28,13 @@ module Google
           # Client for the UptimeCheckService service.
           #
           # The UptimeCheckService API is used to manage (list, create, delete, edit)
-          # Uptime check configurations in the Stackdriver Monitoring product. An Uptime
+          # Uptime check configurations in the Cloud Monitoring product. An Uptime
           # check is a piece of configuration that determines which resources and
           # services to monitor for availability. These configurations can also be
-          # configured interactively by navigating to the [Cloud Console]
-          # (http://console.cloud.google.com), selecting the appropriate project,
-          # clicking on "Monitoring" on the left-hand side to navigate to Stackdriver,
-          # and then clicking on "Uptime".
+          # configured interactively by navigating to the [Cloud console]
+          # (https://console.cloud.google.com), selecting the appropriate project,
+          # clicking on "Monitoring" on the left-hand side to navigate to Cloud
+          # Monitoring, and then clicking on "Uptime".
           #
           class Client
             include Paths
@@ -189,7 +189,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_uptime_check_configs(parent: nil, page_size: nil, page_token: nil)
+            # @overload list_uptime_check_configs(parent: nil, filter: nil, page_size: nil, page_token: nil)
             #   Pass arguments to `list_uptime_check_configs` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -200,6 +200,12 @@ module Google
             #     Uptime check configurations are listed. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
+            #   @param filter [::String]
+            #     If provided, this field specifies the criteria that must be met by
+            #     uptime checks to be included in the response.
+            #
+            #     For more details, see [Filtering
+            #     syntax](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
             #   @param page_size [::Integer]
             #     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
@@ -230,13 +236,11 @@ module Google
             #   # Call the list_uptime_check_configs method.
             #   result = client.list_uptime_check_configs request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Monitoring::V3::UptimeCheckConfig.
-            #     p response
+            #     p item
             #   end
             #
             def list_uptime_check_configs request, options = nil
@@ -490,7 +494,7 @@ module Google
             #     the values for the set of fields mentioned in the `updateMask`. If an
             #     `updateMask` has not been given, this Uptime check configuration replaces
             #     the current configuration. If a field is mentioned in `updateMask` but
-            #     the corresonding field is omitted in this partial Uptime check
+            #     the corresponding field is omitted in this partial Uptime check
             #     configuration, it has the effect of deleting/clearing the field from the
             #     configuration on the server.
             #
@@ -701,13 +705,11 @@ module Google
             #   # Call the list_uptime_check_ips method.
             #   result = client.list_uptime_check_ips request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Monitoring::V3::UptimeCheckIp.
-            #     p response
+            #     p item
             #   end
             #
             def list_uptime_check_ips request, options = nil
@@ -782,9 +784,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/monitoring/v3/uptime_check_service.rb

@@ -32,15 +32,15 @@ module Google
       module V3
         ##
         # The UptimeCheckService API is used to manage (list, create, delete, edit)
-        # Uptime check configurations in the Stackdriver Monitoring product. An Uptime
+        # Uptime check configurations in the Cloud Monitoring product. An Uptime
         # check is a piece of configuration that determines which resources and
         # services to monitor for availability. These configurations can also be
-        # configured interactively by navigating to the [Cloud Console]
-        # (http://console.cloud.google.com), selecting the appropriate project,
-        # clicking on "Monitoring" on the left-hand side to navigate to Stackdriver,
-        # and then clicking on "Uptime".
+        # configured interactively by navigating to the [Cloud console]
+        # (https://console.cloud.google.com), selecting the appropriate project,
+        # clicking on "Monitoring" on the left-hand side to navigate to Cloud
+        # Monitoring, and then clicking on "Uptime".
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/monitoring/v3/uptime_check_service"
         #     client = ::Google::Cloud::Monitoring::V3::UptimeCheckService::Client.new

data/lib/google/cloud/monitoring/v3/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Monitoring
       module V3
-        VERSION = "0.9.0"
+        VERSION = "0.11.0"
       end
     end
   end

data/lib/google/cloud/monitoring/v3.rb

@@ -22,6 +22,7 @@ require "google/cloud/monitoring/v3/metric_service"
 require "google/cloud/monitoring/v3/notification_channel_service"
 require "google/cloud/monitoring/v3/query_service"
 require "google/cloud/monitoring/v3/service_monitoring_service"
+require "google/cloud/monitoring/v3/snooze_service"
 require "google/cloud/monitoring/v3/uptime_check_service"
 require "google/cloud/monitoring/v3/version"
 
@@ -29,9 +30,9 @@ module Google
   module Cloud
     module Monitoring
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/monitoring/v3"
       #     client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new

data/lib/google/monitoring/v3/snooze_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/monitoring/v3/snooze.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/monitoring/v3/common_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/monitoring/v3/snooze.proto", :syntax => :proto3) do
+    add_message "google.monitoring.v3.Snooze" do
+      optional :name, :string, 1
+      optional :criteria, :message, 3, "google.monitoring.v3.Snooze.Criteria"
+      optional :interval, :message, 4, "google.monitoring.v3.TimeInterval"
+      optional :display_name, :string, 5
+    end
+    add_message "google.monitoring.v3.Snooze.Criteria" do
+      repeated :policies, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        Snooze = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.Snooze").msgclass
+        Snooze::Criteria = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.Snooze.Criteria").msgclass
+      end
+    end
+  end
+end

data/lib/google/monitoring/v3/snooze_service_pb.rb

@@ -0,0 +1,51 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/monitoring/v3/snooze_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/monitoring/v3/snooze_pb'
+require 'google/protobuf/field_mask_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/monitoring/v3/snooze_service.proto", :syntax => :proto3) do
+    add_message "google.monitoring.v3.CreateSnoozeRequest" do
+      optional :parent, :string, 1
+      optional :snooze, :message, 2, "google.monitoring.v3.Snooze"
+    end
+    add_message "google.monitoring.v3.ListSnoozesRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :page_size, :int32, 4
+      optional :page_token, :string, 5
+    end
+    add_message "google.monitoring.v3.ListSnoozesResponse" do
+      repeated :snoozes, :message, 1, "google.monitoring.v3.Snooze"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.monitoring.v3.GetSnoozeRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.monitoring.v3.UpdateSnoozeRequest" do
+      optional :snooze, :message, 1, "google.monitoring.v3.Snooze"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        CreateSnoozeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.CreateSnoozeRequest").msgclass
+        ListSnoozesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.ListSnoozesRequest").msgclass
+        ListSnoozesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.ListSnoozesResponse").msgclass
+        GetSnoozeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.GetSnoozeRequest").msgclass
+        UpdateSnoozeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.v3.UpdateSnoozeRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/monitoring/v3/snooze_service_services_pb.rb

@@ -0,0 +1,57 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/monitoring/v3/snooze_service.proto for package 'Google.Cloud.Monitoring.V3'
+# Original file comments:
+# 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/monitoring/v3/snooze_service_pb'
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        module SnoozeService
+          # The SnoozeService API is used to temporarily prevent an alert policy from
+          # generating alerts. A Snooze is a description of the criteria under which one
+          # or more alert policies should not fire alerts for the specified duration.
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.monitoring.v3.SnoozeService'
+
+            # Creates a `Snooze` that will prevent alerts, which match the provided
+            # criteria, from being opened. The `Snooze` applies for a specific time
+            # interval.
+            rpc :CreateSnooze, ::Google::Cloud::Monitoring::V3::CreateSnoozeRequest, ::Google::Cloud::Monitoring::V3::Snooze
+            # Lists the `Snooze`s associated with a project. Can optionally pass in
+            # `filter`, which specifies predicates to match `Snooze`s.
+            rpc :ListSnoozes, ::Google::Cloud::Monitoring::V3::ListSnoozesRequest, ::Google::Cloud::Monitoring::V3::ListSnoozesResponse
+            # Retrieves a `Snooze` by `name`.
+            rpc :GetSnooze, ::Google::Cloud::Monitoring::V3::GetSnoozeRequest, ::Google::Cloud::Monitoring::V3::Snooze
+            # Updates a `Snooze`, identified by its `name`, with the parameters in the
+            # given `Snooze` object.
+            rpc :UpdateSnooze, ::Google::Cloud::Monitoring::V3::UpdateSnoozeRequest, ::Google::Cloud::Monitoring::V3::Snooze
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end