Resource Settings API - Module Google::Cloud::ResourceSettings (v1.1.0)

Reference documentation and code samples for the Resource Settings API module Google::Cloud::ResourceSettings.

Methods

.configure

def self.configure() -> ::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 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.
Yields
  • (::Google::Cloud.configure.resource_settings)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.resource_settings_service

def self.resource_settings_service(version: :v1, &block) -> ResourceSettingsService::Client

Create a new client object for ResourceSettingsService.

By default, this returns an instance of Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client for version V1 of the API. However, you can specify 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.

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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (ResourceSettingsService::Client) — A client object for the specified version.

Constants

VERSION

value: "1.1.0"