Module: Google::Cloud::Billing

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

Constant Summary collapse

VERSION = 
"1.1.2".freeze

Class Method Summary collapse

Class Method Details

.cloud_billing_service(version: :v1, &block) ⇒ CloudBilling::Client

Create a new client object for CloudBilling.

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

About CloudBilling

Retrieves GCP Console billing accounts and associates them with projects.

Parameters:

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

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

Returns:

  • (CloudBilling::Client) —

    A client object for the specified version.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/google/cloud/billing.rb', line 66

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

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

.cloud_catalog_service(version: :v1, &block) ⇒ CloudCatalog::Client

Create a new client object for CloudCatalog.

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

About CloudCatalog

A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

Parameters:

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

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

Returns:

  • (CloudCatalog::Client) —

    A client object for the specified version.



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/billing.rb', line 98

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

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

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

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



137
138
139
140
141
 
# File 'lib/google/cloud/billing.rb', line 137

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

  ::Google::Cloud.configure.billing
end