Connect Gateway API - Module Google::Cloud::GkeConnect::Gateway (v0.4.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.
  • 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
  • (::Google::Cloud.configure.gke_connect_gateway)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.gateway_service

def self.gateway_service(version: :v1beta1, &block) -> ::Object

Create a new client object for GatewayService.

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

About GatewayService

Gateway service is a public API which works as a Kubernetes resource model proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway service will forward user requests to clusters.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional. Defaults to :v1beta1.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "0.4.0"