Module: Google::Cloud::ApigeeConnect

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

Constant Summary collapse

VERSION = 
"1.3.0"

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



142
143
144
145
146
 
# File 'lib/google/cloud/apigee_connect.rb', line 142

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.

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.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/apigee_connect.rb', line 70

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

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

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.



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/apigee_connect.rb', line 103

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