Apigee Connect V1 API - Class Google::Cloud::ApigeeConnect::V1::Tether::Client (v0.1.4)

Reference documentation and code samples for the Apigee Connect V1 API class Google::Cloud::ApigeeConnect::V1::Tether::Client.

Client for the Tether service.

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.

Inherits

Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Tether Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all Tether clients
::Google::Cloud::ApigeeConnect::V1::Tether::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Tether Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#egress

def egress(request, options = nil) { |response, operation| ... } -> ::Enumerable<::Google::Cloud::ApigeeConnect::V1::EgressRequest>

Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.

Parameters

request (::Gapic::StreamInput, ::Enumerable<::Google::Cloud::ApigeeConnect::V1::EgressResponse, ::Hash>) — An enumerable of EgressResponse instances.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Enumerable<::Google::Cloud::ApigeeConnect::V1::EgressRequest>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Enumerable<::Google::Cloud::ApigeeConnect::V1::EgressRequest>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/apigee_connect/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ApigeeConnect::V1::Tether::Client.new

# Create an input stream
input = Gapic::StreamInput.new

# Call the egress method to start streaming.
output = client.egress input

# Send requests on the stream. For each request, pass in keyword
# arguments to set fields. Be sure to close the stream when done.
input << Google::Cloud::ApigeeConnect::V1::EgressResponse.new
input << Google::Cloud::ApigeeConnect::V1::EgressResponse.new
input.close

# Handle streamed responses. These may be interleaved with inputs.
# Each response is of type ::Google::Cloud::ApigeeConnect::V1::EgressRequest.
output.each do |response|
  p response
end

#initialize

def initialize() { |config| ... } -> Client

Create a new Tether client object.

Yields

(config) — Configure the Tether client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::ApigeeConnect::V1::Tether::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ApigeeConnect::V1::Tether::Client.new do |config|
  config.timeout = 10.0
end