Apigee Connect API - Module Google::Cloud::ApigeeConnect (v1.1.0)

Reference documentation and code samples for the Apigee Connect API module Google::Cloud::ApigeeConnect.

Methods

.configure

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

.connection_service

def self.connection_service(version: :v1, &block) -> ConnectionService::Client

Create a new client object for ConnectionService.

By default, this returns an instance of Google::Cloud::ApigeeConnect::V1::ConnectionService::Client for version V1 of the API. However, you can specify 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.

About ConnectionService

Service Interface for the Apigee Connect connection management APIs.

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

.tether

def self.tether(version: :v1, &block) -> Tether::Client

Create a new client object for Tether.

By default, this returns an instance of Google::Cloud::ApigeeConnect::V1::Tether::Client for version V1 of the API. However, you can specify 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.

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

Constants

VERSION

value: "1.1.0"