Module: Google::Cloud::Recommender

Defined in:
lib/google/cloud/recommender.rb,
lib/google/cloud/recommender/version.rb

Constant Summary collapse

VERSION = 
"1.6.2".freeze

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.recommender| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-recommender 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: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional 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.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



149
150
151
152
153
 
# File 'lib/google/cloud/recommender.rb', line 149

def self.configure
  yield ::Google::Cloud.configure.recommender if block_given?

  ::Google::Cloud.configure.recommender
end

.recommender_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for Recommender.

By default, this returns an instance of Google::Cloud::Recommender::V1::Recommender::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the Recommender service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Recommender service. You can determine whether the method will succeed by calling recommender_service_available?.

About Recommender

Provides insights and recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/recommender.rb', line 78

def self.recommender_service version: :v1, transport: :grpc, &block
  require "google/cloud/recommender/#{version.to_s.downcase}"

  package_name = Google::Cloud::Recommender
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Recommender.const_get(package_name).const_get(:Recommender)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.recommender_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the Recommender service is supported by the current client. If true, you can retrieve a client object by calling recommender_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Recommender service, or if the versioned client gem needs an update to support the Recommender service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/recommender.rb', line 102

def self.recommender_service_available? version: :v1, transport: :grpc
  require "google/cloud/recommender/#{version.to_s.downcase}"
  package_name = Google::Cloud::Recommender
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Recommender.const_get package_name
  return false unless service_module.const_defined? :Recommender
  service_module = service_module.const_get :Recommender
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end