module Google::Cloud::Channel

Constants

VERSION

Public Class Methods

cloud_channel_service(version: :v1, &block) click to toggle source

Create a new client object for CloudChannelService.

By default, this returns an instance of [Google::Cloud::Channel::V1::CloudChannelService::Client](googleapis.dev/ruby/google-cloud-channel-v1/latest/Google/Cloud/Channel/V1/CloudChannelService/Client.html) for version V1 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the CloudChannelService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

## About CloudChannelService

CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.

Using this service:

  1. Resellers and distributors can manage a customer entity.

  2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access.

  3. Resellers and distributors can manage customer entitlements.

CloudChannelService exposes the following resources:

  • Customers: An entity—usually an enterprise—managed by a reseller or

distributor.

  • Entitlements: An entity that provides a customer with the means to use

a service. Entitlements are created or updated as a result of a successful fulfillment.

  • ChannelPartnerLinks: An entity that identifies links between

distributors and their indirect resellers in a channel.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [CloudChannelService::Client] A client object for the specified version.

# File lib/google/cloud/channel.rb, line 84
def self.cloud_channel_service version: :v1, &block
  require "google/cloud/channel/#{version.to_s.downcase}"

  package_name = Google::Cloud::Channel
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Channel.const_get package_name
  package_module.const_get(:CloudChannelService).const_get(:Client).new(&block)
end
configure() { |configure.channel| ... } click to toggle source

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

@return [::Google::Cloud::Config] The default configuration used by this library

# File lib/google/cloud/channel.rb, line 123
def self.configure
  yield ::Google::Cloud.configure.channel if block_given?

  ::Google::Cloud.configure.channel
end