Module: Google::Cloud::ServiceControl

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

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

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

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

Returns:

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

    The default configuration used by this library



141
142
143
144
145
 
# File 'lib/google/cloud/service_control.rb', line 141

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

  ::Google::Cloud.configure.service_control
end

.quota_controller(version: :v1, &block) ⇒ QuotaController::Client

Create a new client object for QuotaController.

By default, this returns an instance of Google::Cloud::ServiceControl::V1::QuotaController::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 QuotaController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About QuotaController

Google Quota Control API

Allows clients to allocate and release quota against a managed service.

Parameters:

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

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

Returns:

  • (QuotaController::Client) —

    A client object for the specified version.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/google/cloud/service_control.rb', line 69

def self.quota_controller version: :v1, &block
  require "google/cloud/service_control/#{version.to_s.downcase}"

  package_name = Google::Cloud::ServiceControl
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::ServiceControl.const_get package_name
  package_module.const_get(:QuotaController).const_get(:Client).new(&block)
end

.service_controller(version: :v1, &block) ⇒ ServiceController::Client

Create a new client object for ServiceController.

By default, this returns an instance of Google::Cloud::ServiceControl::V1::ServiceController::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 ServiceController service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About ServiceController

Google Service Control API

Lets clients check and report operations against a managed service.

Parameters:

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

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

Returns:

  • (ServiceController::Client) —

    A client object for the specified version.



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/google/cloud/service_control.rb', line 102

def self.service_controller version: :v1, &block
  require "google/cloud/service_control/#{version.to_s.downcase}"

  package_name = Google::Cloud::ServiceControl
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::ServiceControl.const_get package_name
  package_module.const_get(:ServiceController).const_get(:Client).new(&block)
end