class Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client

Client for the ResourceSettingsService service.

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.

Attributes

resource_settings_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the ResourceSettingsService Client class.

See {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all ResourceSettingsService clients
::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 67
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ResourceSettings", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_settings.timeout = 60.0
    default_config.rpcs.list_settings.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_setting.timeout = 60.0
    default_config.rpcs.get_setting.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_setting.timeout = 60.0
    default_config.rpcs.update_setting.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new ResourceSettingsService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the ResourceSettingsService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 135
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/resourcesettings/v1/resource_settings_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @resource_settings_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the ResourceSettingsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 114
def configure
  yield @config if block_given?
  @config
end
get_setting(request, options = nil) { |response, operation| ... } click to toggle source

Gets a setting.

Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

@overload get_setting(request, options = nil)

Pass arguments to `get_setting` via a request object, either of type
{::Google::Cloud::ResourceSettings::V1::GetSettingRequest} or an equivalent Hash.

@param request [::Google::Cloud::ResourceSettings::V1::GetSettingRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_setting(name: nil, view: nil)

Pass arguments to `get_setting` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the setting to get. See {::Google::Cloud::ResourceSettings::V1::Setting Setting} for naming
  requirements.
@param view [::Google::Cloud::ResourceSettings::V1::SettingView]
  The SettingView for this request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ResourceSettings::V1::Setting] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::ResourceSettings::V1::Setting]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 289
def get_setting request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceSettings::V1::GetSettingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_setting.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ResourceSettings::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_setting.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_setting.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @resource_settings_service_stub.call_rpc :get_setting, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_settings(request, options = nil) { |response, operation| ... } click to toggle source

Lists all the settings that are available on the Cloud resource `parent`.

@overload list_settings(request, options = nil)

Pass arguments to `list_settings` via a request object, either of type
{::Google::Cloud::ResourceSettings::V1::ListSettingsRequest} or an equivalent Hash.

@param request [::Google::Cloud::ResourceSettings::V1::ListSettingsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_settings(parent: nil, page_size: nil, page_token: nil, view: nil)

Pass arguments to `list_settings` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The Cloud resource that parents the setting. Must be in one of the
  following forms:

  * `projects/{project_number}`
  * `projects/{project_id}`
  * `folders/{folder_id}`
  * `organizations/{organization_id}`
@param page_size [::Integer]
  Unused. The size of the page to be returned.
@param page_token [::String]
  Unused. A page token used to retrieve the next page.
@param view [::Google::Cloud::ResourceSettings::V1::SettingView]
  The SettingView for this request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ResourceSettings::V1::Setting>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::ResourceSettings::V1::Setting>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 214
def list_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceSettings::V1::ListSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ResourceSettings::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @resource_settings_service_stub.call_rpc :list_settings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @resource_settings_service_stub, :list_settings, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_setting(request, options = nil) { |response, operation| ... } click to toggle source

Updates a setting.

Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the setting is flagged as read only. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the setting value.

On success, the response will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API.

Note: the supplied setting will perform a full overwrite of the `local_value` field.

@overload update_setting(request, options = nil)

Pass arguments to `update_setting` via a request object, either of type
{::Google::Cloud::ResourceSettings::V1::UpdateSettingRequest} or an equivalent Hash.

@param request [::Google::Cloud::ResourceSettings::V1::UpdateSettingRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_setting(setting: nil)

Pass arguments to `update_setting` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param setting [::Google::Cloud::ResourceSettings::V1::Setting, ::Hash]
  Required. The setting to update. See {::Google::Cloud::ResourceSettings::V1::Setting Setting} for field requirements.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ResourceSettings::V1::Setting] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::ResourceSettings::V1::Setting]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb, line 372
def update_setting request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceSettings::V1::UpdateSettingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_setting.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ResourceSettings::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "setting.name" => request.setting.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_setting.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_setting.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @resource_settings_service_stub.call_rpc :update_setting, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end