Connect Gateway API - Module Google::Cloud::GkeConnect::Gateway (v2.1.0)

Reference documentation and code samples for the Connect Gateway API module Google::Cloud::GkeConnect::Gateway.

Methods

.configure

def self.configure() -> ::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
  • (::Google::Cloud.configure.gke_connect_gateway)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.gateway_control

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

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

About GatewayControl

GatewayControl is the control plane API for Connect Gateway.

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

.gateway_control_available?

def self.gateway_control_available?(version: :v1) -> boolean

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "2.1.0"