Cloud Quotas API - Module Google::Cloud::CloudQuotas (v2.0.1)

Reference documentation and code samples for the Cloud Quotas API module Google::Cloud::CloudQuotas.

Methods

.cloud_quotas

def self.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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the CloudQuotas service. You can determine whether the method will succeed by calling CloudQuotas.cloud_quotas_available?.

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.

.cloud_quotas_available?

def self.cloud_quotas_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the CloudQuotas service is supported by the current client. If true, you can retrieve a client object by calling CloudQuotas.cloud_quotas. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the CloudQuotas service, or if the versioned client gem needs an update to support the CloudQuotas 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
  • (boolean) — Whether the service is available.

.configure

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

Constants

VERSION

value: "2.0.1"