Module: Google::Cloud::Commerce::Consumer::Procurement

Defined in:
lib/google/cloud/commerce/consumer/procurement.rb,
lib/google/cloud/commerce/consumer/procurement/version.rb

Constant Summary collapse

VERSION = 
"1.1.0"

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-commerce-consumer-procurement 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



154
155
156
157
158
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 154

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

  ::Google::Cloud.configure.commerce_consumer_procurement
end

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

Create a new client object for ConsumerProcurementService.

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

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

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.



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 114

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

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

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

Create a new client object for LicenseManagementService.

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

Service for managing licenses.

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.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 72

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

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