Module: Google::Cloud::Channel

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

Constant Summary collapse

VERSION = 
"2.0.2"

Class Method Summary collapse

Class Method Details

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

Create a new client object for CloudChannelReportsService.

By default, this returns an instance of Google::Cloud::Channel::V1::CloudChannelReportsService::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 CloudChannelReportsService 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 CloudChannelReportsService service. You can determine whether the method will succeed by calling cloud_channel_reports_service_available?.

About CloudChannelReportsService

CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud, Google Voice, and Google Workspace.)

Deprecated: This service is being deprecated. Please use Export Channel Services data to BigQuery instead.

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.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/google/cloud/channel.rb', line 82

def self.cloud_channel_reports_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Channel.const_get(package_name).const_get(:CloudChannelReportsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

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

Determines whether the CloudChannelReportsService service is supported by the current client. If true, you can retrieve a client object by calling cloud_channel_reports_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 CloudChannelReportsService service, or if the versioned client gem needs an update to support the CloudChannelReportsService 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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/channel.rb', line 106

def self.cloud_channel_reports_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Channel.const_get package_name
  return false unless service_module.const_defined? :CloudChannelReportsService
  service_module = service_module.const_get :CloudChannelReportsService
  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

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

Create a new client object for CloudChannelService.

By default, this returns an instance of Google::Cloud::Channel::V1::CloudChannelService::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 CloudChannelService 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 CloudChannelService service. You can determine whether the method will succeed by calling cloud_channel_service_available?.

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.

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.



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/google/cloud/channel.rb', line 171

def self.cloud_channel_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Channel.const_get(package_name).const_get(:CloudChannelService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

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

Determines whether the CloudChannelService service is supported by the current client. If true, you can retrieve a client object by calling cloud_channel_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 CloudChannelService service, or if the versioned client gem needs an update to support the CloudChannelService 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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/cloud/channel.rb', line 195

def self.cloud_channel_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Channel.const_get package_name
  return false unless service_module.const_defined? :CloudChannelService
  service_module = service_module.const_get :CloudChannelService
  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

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

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 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



242
243
244
245
246
 
# File 'lib/google/cloud/channel.rb', line 242

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

  ::Google::Cloud.configure.channel
end