Module: Google::Cloud::ApigeeConnect

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

Constant Summary collapse

VERSION = 
"1.5.2"

Class Method Summary collapse

Class Method Details

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

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



209
210
211
212
213
 
# File 'lib/google/cloud/apigee_connect.rb', line 209

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

  ::Google::Cloud.configure.apigee_connect
end

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

Create a new client object for ConnectionService.

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

About ConnectionService

Service Interface for the Apigee Connect connection management APIs.

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.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/apigee_connect.rb', line 75

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

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

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

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/apigee_connect.rb', line 99

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

.tether(version: :v1, &block) ⇒ ::Object

Create a new client object for Tether.

By default, this returns an instance of Google::Cloud::ApigeeConnect::V1::Tether::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 Tether service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

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

About Tether

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/google/cloud/apigee_connect.rb', line 144

def self.tether version: :v1, &block
  require "google/cloud/apigee_connect/#{version.to_s.downcase}"

  package_name = Google::Cloud::ApigeeConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::ApigeeConnect.const_get(package_name).const_get(:Tether)
  service_module.const_get(:Client).new(&block)
end

.tether_available?(version: :v1) ⇒ boolean

Determines whether the Tether service is supported by the current client. If true, you can retrieve a client object by calling tether. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Tether service, or if the versioned client gem needs an update to support the Tether service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (boolean) —

    Whether the service is available.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/google/cloud/apigee_connect.rb', line 166

def self.tether_available? version: :v1
  require "google/cloud/apigee_connect/#{version.to_s.downcase}"
  package_name = Google::Cloud::ApigeeConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::ApigeeConnect.const_get package_name
  return false unless service_module.const_defined? :Tether
  service_module = service_module.const_get :Tether
  service_module.const_defined? :Client
rescue ::LoadError
  false
end