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.2.2"

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



226
227
228
229
230
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 226

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.

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

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.



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 155

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

.consumer_procurement_service_available?(version: :v1, transport: :grpc) ⇒ boolean

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 179

def self.consumer_procurement_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Commerce::Consumer::Procurement.const_get package_name
  return false unless service_module.const_defined? :ConsumerProcurementService
  service_module = service_module.const_get :ConsumerProcurementService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

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

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.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 77

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

.license_management_service_available?(version: :v1, transport: :grpc) ⇒ boolean

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google/cloud/commerce/consumer/procurement.rb', line 101

def self.license_management_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Commerce::Consumer::Procurement.const_get package_name
  return false unless service_module.const_defined? :LicenseManagementService
  service_module = service_module.const_get :LicenseManagementService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end