dashboard.rb in google-cloud-monitoring-1.0.0

- old
+ new

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Copyright 2020 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
@@ -10,138 +12,107 @@
 # 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 "google/gax"
-require "pathname"
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/monitoring/dashboard/version"
 
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :monitoring_dashboard do |config|
+  config.add_field! :endpoint,      "monitoring.googleapis.com", match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+end
+
 module Google
   module Cloud
     module Monitoring
-      # rubocop:disable LineLength
-
-      ##
-      # # Ruby Client for Stackdriver Monitoring Dashboards API
-      #
-      # [Stackdriver Monitoring Dashboards API][Product Documentation]:
-      # Manages dashboard configurations used in the Stackdriver UI.
-      # - [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 billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-      # 3. [Enable the Stackdriver Monitoring Dashboards API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
-      # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-monitoring/latest/file.AUTHENTICATION.html)
-      #
-      # ### Installation
-      # ```
-      # $ gem install google-cloud-monitoring-dashboard
-      # ```
-      #
-      # ### Next Steps
-      # - Read the [Stackdriver Monitoring Dashboards 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/googleapis/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
-      #
-      # ## Enabling Logging
-      #
-      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-      #
-      # Configuring a Ruby stdlib logger:
-      #
-      # ```ruby
-      # require "logger"
-      #
-      # module MyLogger
-      #   LOGGER = Logger.new $stderr, level: Logger::WARN
-      #   def logger
-      #     LOGGER
-      #   end
-      # end
-      #
-      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-      # module GRPC
-      #   extend MyLogger
-      # end
-      # ```
-      #
       module Dashboard
-        # rubocop:enable LineLength
-
-        FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("dashboard"))
-
-        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) }
-
         ##
+        # Create a new client object for DashboardsService.
+        #
+        # By default, this returns an instance of
+        # [Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client](https://googleapis.dev/ruby/google-cloud-monitoring-dashboard-v1/latest/Google/Cloud/Monitoring/Dashboard/V1/DashboardsService/Client.html)
+        # for version V1 of the API.
+        # However, you can specify specify a different API version by passing it in the
+        # `version` parameter. If the DashboardsService service is
+        # supported by that API version, and the corresponding gem is available, the
+        # appropriate versioned client will be returned.
+        #
+        # ## About DashboardsService
+        #
         # Manages Stackdriver dashboards. A dashboard is an arrangement of data display
         # widgets in a specific layout.
         #
-        # @param version [Symbol, String]
-        #   The major version of the service to be used. By default :v1
-        #   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.
-        #   @param metadata [Hash]
-        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
-        #   @param service_address [String]
-        #     Override for the service hostname, or `nil` to leave as the default.
-        #   @param service_port [Integer]
-        #     Override for the service port, or `nil` to leave as the default.
-        #   @param exception_transformer [Proc]
-        #     An optional proc that intercepts any exceptions raised during an API call to inject
-        #     custom error handling.
-        def self.new(*args, version: :v1, **kwargs)
-          unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-            raise "The version: #{version} is not available. The available versions " \
-              "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-          end
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @return [DashboardsService::Client] A client object for the specified version.
+        #
+        def self.dashboards_service version: :v1, &block
+          require "google/cloud/monitoring/dashboard/#{version.to_s.downcase}"
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::Monitoring::Dashboard
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::Monitoring::Dashboard.const_get(version_module).new(*args, **kwargs)
+          package_name = Google::Cloud::Monitoring::Dashboard
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          package_module = Google::Cloud::Monitoring::Dashboard.const_get package_name
+          package_module.const_get(:DashboardsService).const_get(:Client).new(&block)
         end
+
+        ##
+        # Configure the google-cloud-monitoring-dashboard library.
+        #
+        # The following configuration parameters are supported:
+        #
+        # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
+        #   The path to the keyfile as a String, the contents of the keyfile as a
+        #   Hash, or a Google::Auth::Credentials object.
+        # * `lib_name` (*type:* `String`) -
+        #   The library name as recorded in instrumentation and logging.
+        # * `lib_version` (*type:* `String`) -
+        #   The library version as recorded in instrumentation and logging.
+        # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+        #   An array of interceptors that are run before calls are executed.
+        # * `timeout` (*type:* `Integer`) -
+        #   Default timeout in milliseconds.
+        # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+        #   Additional gRPC headers to be sent with the call.
+        # * `retry_policy` (*type:* `Hash`) -
+        #   The retry policy. The value is a hash with the following keys:
+        #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+        #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+        #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+        #     * `:retry_codes` (*type:* `Array<String>`) -
+        #       The error codes that should trigger a retry.
+        #
+        # @return [::Google::Cloud::Config] The default configuration used by this library
+        #
+        def self.configure
+          yield ::Google::Cloud.configure.monitoring_dashboard if block_given?
+
+          ::Google::Cloud.configure.monitoring_dashboard
+        end
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "dashboard", "helpers.rb"
+require "google/cloud/monitoring/dashboard/helpers" if ::File.file? helper_path