Module: Google::Cloud::ResourceSettings

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

Constant Summary collapse

VERSION = 
"1.5.0"

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-resource_settings 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



160
161
162
163
164
 
# File 'lib/google/cloud/resource_settings.rb', line 160

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

  ::Google::Cloud.configure.resource_settings
end

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

Create a new client object for ResourceSettingsService.

By default, this returns an instance of Google::Cloud::ResourceSettings::V1::ResourceSettingsService::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 ResourceSettingsService 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 ResourceSettingsService service. You can determine whether the method will succeed by calling resource_settings_service_available?.

About ResourceSettingsService

An interface to interact with resource settings and setting values throughout the resource hierarchy.

Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.

For all requests, returns a google.rpc.Status with google.rpc.Code.PERMISSION_DENIED if the IAM check fails or the parent resource is not in a Cloud Organization. For all requests, returns a google.rpc.Status with google.rpc.Code.INVALID_ARGUMENT if the request is malformed. (== deprecation_description Resource Settings is deprecated. As of November 7, 2023, no organizations will be onboarded for any of the enabled settings, and the service will be shut down on October 1, 2024. ==)

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.



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/resource_settings.rb', line 89

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

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

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

Determines whether the ResourceSettingsService service is supported by the current client. If true, you can retrieve a client object by calling resource_settings_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 ResourceSettingsService service, or if the versioned client gem needs an update to support the ResourceSettingsService 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.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/resource_settings.rb', line 113

def self.resource_settings_service_available? version: :v1, transport: :grpc
  require "google/cloud/resource_settings/#{version.to_s.downcase}"
  package_name = Google::Cloud::ResourceSettings
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::ResourceSettings.const_get package_name
  return false unless service_module.const_defined? :ResourceSettingsService
  service_module = service_module.const_get :ResourceSettingsService
  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