Module: Google::Cloud::CloudQuotas

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

Constant Summary collapse

VERSION = 
"1.0.1"

Class Method Summary collapse

Class Method Details

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

Create a new client object for CloudQuotas.

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

The Cloud Quotas API is an infrastructure service for Google Cloud that lets service consumers list and manage their resource usage limits.

  • List/Get the metadata and current status of the quotas for a service.
  • Create/Update quota preferencess that declare the preferred quota values.
  • Check the status of a quota preference request.
  • List/Get pending and historical quota preference.

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.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/google/cloud/cloud_quotas.rb', line 76

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

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

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

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



116
117
118
119
120
 
# File 'lib/google/cloud/cloud_quotas.rb', line 116

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

  ::Google::Cloud.configure.cloud_quotas
end