Cloud Commerce Consumer Procurement API - Module Google::Cloud::Commerce::Consumer::Procurement (v1.2.0)

Reference documentation and code samples for the Cloud Commerce Consumer Procurement API module Google::Cloud::Commerce::Consumer::Procurement.

Methods

.configure

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

.consumer_procurement_service

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

.consumer_procurement_service_available?

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

.license_management_service

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

.license_management_service_available?

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

Constants

VERSION

value: "1.2.0"