Module: Google::Cloud::ServiceControl

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

Constant Summary collapse

VERSION = 
"1.4.1"

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 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



150
151
152
153
154
 
# File 'lib/google/cloud/service_control.rb', line 150

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

  ::Google::Cloud.configure.service_control
end

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

Create a new client object for QuotaController.

By default, this returns an instance of Google::Cloud::ServiceControl::V1::QuotaController::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 QuotaController 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.

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.

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/service_control.rb', line 73

def self.quota_controller version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::ServiceControl.const_get(package_name).const_get(:QuotaController)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

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

Create a new client object for ServiceController.

By default, this returns an instance of Google::Cloud::ServiceControl::V1::ServiceController::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 ServiceController 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.

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.

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/cloud/service_control.rb', line 110

def self.service_controller version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::ServiceControl.const_get(package_name).const_get(:ServiceController)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end