Apigee Connect API - Module Google::Cloud::ApigeeConnect (v1.5.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 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, 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ConnectionService service. You can determine whether the method will succeed by calling ApigeeConnect.connection_service_available?.

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.

.connection_service_available?

def self.connection_service_available?(version: :v1, transport: :grpc) -> boolean

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

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
  • (boolean) — Whether the service is available.

.tether

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

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

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
  • (::Object) — A client object for the specified version.

.tether_available?

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

Determines whether the Tether service is supported by the current client. If true, you can retrieve a client object by calling ApigeeConnect.tether. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Tether service, or if the versioned client gem needs an update to support the Tether 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: "1.5.0"