google-cloud-monitoring 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05bb95e98dc3f0c69cdbf51c258ae2ac0e8bc46d
-  data.tar.gz: 9eefc90e8d84691e7e2a2f78fba442d8d99235a7
+SHA256:
+  metadata.gz: 2fc728f5655949b2cb01436fbffb1645e3410f80516e28c4c6ac737a444baf04
+  data.tar.gz: dd11745defa0ad42c0e3a0ae031480114714ebd17ee0da3f8a41690fe4eb55f1
 SHA512:
-  metadata.gz: 70ac93cc06d5993bc2cc45f0f69cc24cde1bb59e2e317f3b4eb32bfa3ea5ef0c43eb63a664701dd62aa178d66b5e8a8159c2274f0a7993e2648273399e01c4e8
-  data.tar.gz: d1abae8219dff92e473240d77aa32e9b9fd13d2a920bec110950004d201aa8094de54d3c6a3c29ea470f22eb7aa7916a323f12c97f458ebc85c9e31554fe051e
+  metadata.gz: 3803f01f65283231049136ed9bcb0560b9e194bb3f4ec99a386fd14ec0638a2041f16e817bdd8867f43e23efac2efdd035eb9d1bbf53d6cd50265cb26d6f41a6
+  data.tar.gz: d0b8d27ddf88c29cf6f5bb94641adab74400ec5b625356e5dd8e4979e236826a0553c3263c2e54928114ed40f61dd8afd0ec6cb0f353d8c696cc5236a532917b

data/.yardopts

@@ -1,6 +1,6 @@
 --no-private
---title=Stackdriver Monitoring
---exclude lib/google/monitoring/v3
+--title=Stackdriver Monitoring API
+--exclude _pb\.rb$
 --markup markdown
 
 ./lib/**/*.rb

data/README.md

@@ -1,15 +1,18 @@
-# Ruby Client for Stackdriver Monitoring API (Alpha)
-
-Idiomatic Ruby client for [Stackdriver Monitoring API][Product Documentation]
+# Ruby Client for Stackdriver Monitoring API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
 
+[Stackdriver Monitoring API][Product Documentation]:
+Manages your Stackdriver Monitoring data and configurations. Most projects must
+be associated with a Stackdriver account, with a few exceptions as noted on the
+individual method pages.
 - [Client Library Documentation][]
 - [Product Documentation][]
 
 ## Quick Start
-In order to use this library, you first need to go through the following steps:
+In order to use this library, you first need to go through the following
+steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-2. [Enable the monitoring api.](https://console.cloud.google.com/apis/api/monitoring)
+2. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/api/monitoring)
 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
 
 ### Installation
@@ -20,31 +23,32 @@ $ gem install google-cloud-monitoring
 ### Preview
 #### MetricServiceClient
 ```rb
- require "google/cloud/monitoring/v3"
-
- MetricServiceClient = Google::Cloud::Monitoring::V3::MetricServiceClient
-
- metric_service_client = MetricServiceClient.new
- formatted_name = MetricServiceClient.project_path(project_id)
-
- # Iterate over all results.
- metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
-   # Process element.
- end
-
- # Or iterate over results one page at a time.
- metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
-   # Process each page at a time.
-   page.each do |element|
-     # Process element.
-   end
- end
+require "google/cloud/monitoring"
+
+metric_service_client = Google::Cloud::Monitoring::Metric.new
+formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
+
+# Iterate over all results.
+metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
+  # Process element.
+end
+
+# Or iterate over results one page at a time.
+metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
+  # Process each page at a time.
+  page.each do |element|
+    # Process element.
+  end
+end
 ```
 
 ### Next Steps
-- Read the [Client Library Documentation][] for Stackdriver Monitoring API to see other available methods on the client.
-- Read the [Stackdriver Monitoring API Product documentation][Product Documentation] to learn more about the product and see How-to Guides.
-- View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md) to see the full list of Cloud APIs that we cover.
+- Read the [Client Library Documentation][] for Stackdriver Monitoring API
+  to see other available methods on the client.
+- Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
+  to learn more about the product and see How-to Guides.
+- View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+  to see the full list of Cloud APIs that we cover.
 
 [Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-monitoring/latest/google/monitoring/v3
-[Product Documentation]: https://cloud.google.com/monitoring
+[Product Documentation]: https://cloud.google.com/monitoring

data/lib/google-cloud-monitoring.rb

@@ -13,8 +13,6 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .logging and
-# #logging methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# This file is here to be autorequired by bundler.
 
 # There is no Google::Cloud integration to add.

data/lib/google/cloud/monitoring.rb

@@ -0,0 +1,188 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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 "google/gax"
+require "pathname"
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Stackdriver Monitoring API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Monitoring API][Product Documentation]:
+    # Manages your Stackdriver Monitoring data and configurations. Most projects must
+    # be associated with a Stackdriver account, with a few exceptions as noted on the
+    # individual method pages.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/api/monitoring)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Preview
+    # #### MetricServiceClient
+    # ```rb
+    # require "google/cloud/monitoring"
+    #
+    # metric_service_client = Google::Cloud::Monitoring::Metric.new
+    # formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
+    #
+    # # Iterate over all results.
+    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
+    #   # Process element.
+    # end
+    #
+    # # Or iterate over results one page at a time.
+    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
+    #   # Process each page at a time.
+    #   page.each do |element|
+    #     # Process element.
+    #   end
+    # end
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/monitoring
+    #
+    #
+    module Monitoring
+      # rubocop:enable LineLength
+
+      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("monitoring"))
+
+      AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
+        .select { |file| File.directory?(file) }
+        .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
+        .select { |dir| File.exist?(dir + ".rb") }
+        .map { |dir| File.basename(dir) }
+
+      module Group
+        ##
+        # The Group API lets you inspect and manage your
+        # [groups](https://cloud.google.comgoogle.monitoring.v3.Group).
+        #
+        # A group is a named filter that is used to identify
+        # a collection of monitored resources. Groups are typically used to
+        # mirror the physical and/or logical topology of the environment.
+        # Because group membership is computed dynamically, monitored
+        # resources that are started in the future are automatically placed
+        # in matching groups. By using a group to name monitored resources in,
+        # for example, an alert policy, the target of that alert policy is
+        # updated automatically as monitored resources are added and removed
+        # from the infrastructure.
+        #
+        # @param version [Symbol, String]
+        #   The major version of the service to be used. By default :v3
+        #   is used.
+        # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
+        #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #     Provides the means for authenticating requests made by the client. This parameter can
+        #     be many types.
+        #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #     authenticating requests made by this client.
+        #     A `String` will be treated as the path to the keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `GRPC::Core::Channel` will be used to make calls through.
+        #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #     should already be composed with a `GRPC::Core::CallCredentials` object.
+        #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #     metadata for requests, generally, to give OAuth credentials.
+        #   @param scopes [Array<String>]
+        #     The OAuth scopes for this service. This parameter is ignored if
+        #     an updater_proc is supplied.
+        #   @param client_config [Hash]
+        #     A Hash for call options for each method. See
+        #     Google::Gax#construct_settings for the structure of
+        #     this data. Falls back to the default config if not specified
+        #     or the specified config is missing data points.
+        #   @param timeout [Numeric]
+        #     The default timeout, in seconds, for calls made through this client.
+        def self.new(*args, version: :v3, **kwargs)
+          unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
+            raise "The version: #{version} is not available. The available versions " \
+              "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
+          end
+
+          require "#{FILE_DIR}/#{version.to_s.downcase}"
+          version_module = Google::Cloud::Monitoring
+            .constants
+            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
+            .first
+          Google::Cloud::Monitoring.const_get(version_module)::Group.new(*args, **kwargs)
+        end
+      end
+
+      module Metric
+        ##
+        # Manages metric descriptors, monitored resource descriptors, and
+        # time series data.
+        #
+        # @param version [Symbol, String]
+        #   The major version of the service to be used. By default :v3
+        #   is used.
+        # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
+        #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #     Provides the means for authenticating requests made by the client. This parameter can
+        #     be many types.
+        #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #     authenticating requests made by this client.
+        #     A `String` will be treated as the path to the keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `GRPC::Core::Channel` will be used to make calls through.
+        #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #     should already be composed with a `GRPC::Core::CallCredentials` object.
+        #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #     metadata for requests, generally, to give OAuth credentials.
+        #   @param scopes [Array<String>]
+        #     The OAuth scopes for this service. This parameter is ignored if
+        #     an updater_proc is supplied.
+        #   @param client_config [Hash]
+        #     A Hash for call options for each method. See
+        #     Google::Gax#construct_settings for the structure of
+        #     this data. Falls back to the default config if not specified
+        #     or the specified config is missing data points.
+        #   @param timeout [Numeric]
+        #     The default timeout, in seconds, for calls made through this client.
+        def self.new(*args, version: :v3, **kwargs)
+          unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
+            raise "The version: #{version} is not available. The available versions " \
+              "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
+          end
+
+          require "#{FILE_DIR}/#{version.to_s.downcase}"
+          version_module = Google::Cloud::Monitoring
+            .constants
+            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
+            .first
+          Google::Cloud::Monitoring.const_get(version_module)::Metric.new(*args, **kwargs)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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 "googleauth"
+
+module Google
+  module Cloud
+    module Monitoring
+      class Credentials < Google::Auth::Credentials
+        SCOPE = [
+          "https://www.googleapis.com/auth/cloud-platform",
+          "https://www.googleapis.com/auth/monitoring",
+          "https://www.googleapis.com/auth/monitoring.read",
+          "https://www.googleapis.com/auth/monitoring.write"
+        ].freeze
+        PATH_ENV_VARS = %w(MONITORING_KEYFILE, GOOGLE_CLOUD_KEYFILE, GCLOUD_KEYFILE)
+        JSON_ENV_VARS = %w(MONITORING_KEYFILE_JSON, GOOGLE_CLOUD_KEYFILE_JSON, GCLOUD_KEYFILE_JSON)
+        DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+      end
+    end
+  end
+end

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

@@ -1,5 +1,4 @@
-
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +12,191 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 require "google/cloud/monitoring/v3/group_service_client"
 require "google/cloud/monitoring/v3/metric_service_client"
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Stackdriver Monitoring API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Monitoring API][Product Documentation]:
+    # Manages your Stackdriver Monitoring data and configurations. Most projects must
+    # be associated with a Stackdriver account, with a few exceptions as noted on the
+    # individual method pages.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/api/monitoring)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Preview
+    # #### MetricServiceClient
+    # ```rb
+    # require "google/cloud/monitoring/v3"
+    #
+    # metric_service_client = Google::Cloud::Monitoring::V3::Metric.new
+    # formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
+    #
+    # # Iterate over all results.
+    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
+    #   # Process element.
+    # end
+    #
+    # # Or iterate over results one page at a time.
+    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
+    #   # Process each page at a time.
+    #   page.each do |element|
+    #     # Process element.
+    #   end
+    # end
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/monitoring
+    #
+    #
+    module Monitoring
+      module V3
+        # rubocop:enable LineLength
+
+        module Group
+          ##
+          # The Group API lets you inspect and manage your
+          # [groups](https://cloud.google.comgoogle.monitoring.v3.Group).
+          #
+          # A group is a named filter that is used to identify
+          # a collection of monitored resources. Groups are typically used to
+          # mirror the physical and/or logical topology of the environment.
+          # Because group membership is computed dynamically, monitored
+          # resources that are started in the future are automatically placed
+          # in matching groups. By using a group to name monitored resources in,
+          # for example, an alert policy, the target of that alert policy is
+          # updated automatically as monitored resources are added and removed
+          # from the infrastructure.
+          #
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def self.new \
+              service_path: nil,
+              port: nil,
+              channel: nil,
+              chan_creds: nil,
+              updater_proc: nil,
+              credentials: nil,
+              scopes: nil,
+              client_config: nil,
+              timeout: nil,
+              lib_name: nil,
+              lib_version: nil
+            kwargs = {
+              service_path: service_path,
+              port: port,
+              channel: channel,
+              chan_creds: chan_creds,
+              updater_proc: updater_proc,
+              credentials: credentials,
+              scopes: scopes,
+              client_config: client_config,
+              timeout: timeout,
+              lib_name: lib_name,
+              lib_version: lib_version
+            }.select { |_, v| v != nil }
+            Google::Cloud::Monitoring::V3::GroupServiceClient.new(**kwargs)
+          end
+        end
+
+        module Metric
+          ##
+          # Manages metric descriptors, monitored resource descriptors, and
+          # time series data.
+          #
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def self.new \
+              service_path: nil,
+              port: nil,
+              channel: nil,
+              chan_creds: nil,
+              updater_proc: nil,
+              credentials: nil,
+              scopes: nil,
+              client_config: nil,
+              timeout: nil,
+              lib_name: nil,
+              lib_version: nil
+            kwargs = {
+              service_path: service_path,
+              port: port,
+              channel: channel,
+              chan_creds: chan_creds,
+              updater_proc: updater_proc,
+              credentials: credentials,
+              scopes: scopes,
+              client_config: client_config,
+              timeout: timeout,
+              lib_name: lib_name,
+              lib_version: lib_version
+            }.select { |_, v| v != nil }
+            Google::Cloud::Monitoring::V3::MetricServiceClient.new(**kwargs)
+          end
+        end
+      end
+    end
+  end
+end