Apigee Connect V1 API - Class Google::Cloud::ApigeeConnect::V1::ConnectionService::Client (v1.1.0)

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

Client for the ConnectionService service.

Service Interface for the Apigee Connect connection management APIs.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the ConnectionService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ConnectionService clients
::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the ConnectionService 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
Returns

#initialize

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

Create a new ConnectionService client object.

Yields
  • (config) — Configure the ConnectionService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.new

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

#list_connections

def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ApigeeConnect::V1::Connection>
def list_connections(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ApigeeConnect::V1::Connection>

Lists connections that are currently active for the given Apigee Connect endpoint.

Overloads 
def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ApigeeConnect::V1::Connection>
Pass arguments to list_connections via a request object, either of type ListConnectionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ApigeeConnect::V1::ListConnectionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_connections(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ApigeeConnect::V1::Connection>
Pass arguments to list_connections via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}.
  • page_size (::Integer) — The maximum number of connections to return. The service may return fewer than this value. If unspecified, at most 100 connections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListConnections call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListConnections must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ApigeeConnect::V1::ListConnectionsRequest.new

# Call the list_connections method.
result = client.list_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ApigeeConnect::V1::Connection.
  p item
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)