Module: Google::Cloud::GkeConnect::Gateway

Defined in:
lib/google/cloud/gke_connect/gateway.rb,
lib/google/cloud/gke_connect/gateway/version.rb

Constant Summary collapse

VERSION = 
"2.0.0"

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-gke_connect-gateway 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.
  • 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



104
105
106
107
108
 
# File 'lib/google/cloud/gke_connect/gateway.rb', line 104

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

  ::Google::Cloud.configure.gke_connect_gateway
end

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

Create a new client object for GatewayControl.

By default, this returns an instance of Google::Cloud::GkeConnect::Gateway::V1::GatewayControl::Rest::Client for a REST client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the GatewayControl service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About GatewayControl

GatewayControl is the control plane API for Connect Gateway.

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.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/cloud/gke_connect/gateway.rb', line 67

def self.gateway_control version: :v1, &block
  require "google/cloud/gke_connect/gateway/#{version.to_s.downcase}"

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