Module: Google::Cloud::Eventarc::Publishing

Defined in:
lib/google/cloud/eventarc/publishing.rb,
lib/google/cloud/eventarc/publishing/version.rb

Constant Summary collapse

VERSION = 
"1.3.2"

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-eventarc-publishing 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



175
176
177
178
179
 
# File 'lib/google/cloud/eventarc/publishing.rb', line 175

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

  ::Google::Cloud.configure.eventarc_publishing
end

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

Create a new client object for Publisher.

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

About Publisher

Eventarc processes events generated by an event provider and delivers them to a subscriber.

An event provider is a software-as-a-service (SaaS) system or product that can generate and deliver events through Eventarc.

A third-party event provider is an event provider from outside of Google.

A partner is a third-party event provider that is integrated with Eventarc.

A subscriber is a Google Cloud customer interested in receiving events.

Channel is a first-class Eventarc resource that is created and managed by the subscriber in their Google Cloud project. A Channel represents a subscriber's intent to receive events from an event provider. A Channel is associated with exactly one event provider.

ChannelConnection is a first-class Eventarc resource that is created and managed by the partner in their Google Cloud project. A ChannelConnection represents a connection between a partner and a subscriber's Channel. A ChannelConnection has a one-to-one mapping with a Channel.

Bus is a first-class Eventarc resource that is created and managed in a Google Cloud project. A Bus provides a discoverable endpoint for events and is a router that receives all events published by event providers and delivers them to zero or more subscribers.

Publisher allows an event provider to publish events to Eventarc.

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.



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/cloud/eventarc/publishing.rb', line 104

def self.publisher version: :v1, transport: :grpc, &block
  require "google/cloud/eventarc/publishing/#{version.to_s.downcase}"

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

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

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/google/cloud/eventarc/publishing.rb', line 128

def self.publisher_available? version: :v1, transport: :grpc
  require "google/cloud/eventarc/publishing/#{version.to_s.downcase}"
  package_name = Google::Cloud::Eventarc::Publishing
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Eventarc::Publishing.const_get package_name
  return false unless service_module.const_defined? :Publisher
  service_module = service_module.const_get :Publisher
  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