Module: Google::Cloud::NetworkConnectivity

Defined in:
lib/google/cloud/network_connectivity.rb,
lib/google/cloud/network_connectivity/version.rb

Constant Summary collapse

VERSION = 
"1.5.1"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.network_connectivity| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-network_connectivity 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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



139
140
141
142
143
 
# File 'lib/google/cloud/network_connectivity.rb', line 139

def self.configure
  yield ::Google::Cloud.configure.network_connectivity if block_given?

  ::Google::Cloud.configure.network_connectivity
end

.hub_service(version: :v1, &block) ⇒ ::Object

Create a new client object for HubService.

By default, this returns an instance of Google::Cloud::NetworkConnectivity::V1::HubService::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 HubService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About HubService

Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.

Parameters:

  • 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.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/google/cloud/network_connectivity.rb', line 69

def self.hub_service version: :v1, &block
  require "google/cloud/network_connectivity/#{version.to_s.downcase}"

  package_name = Google::Cloud::NetworkConnectivity
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::NetworkConnectivity.const_get(package_name).const_get(:HubService)
  service_module.const_get(:Client).new(&block)
end

.policy_based_routing_service(version: :v1, &block) ⇒ ::Object

Create a new client object for PolicyBasedRoutingService.

By default, this returns an instance of Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoutingService::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 PolicyBasedRoutingService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About PolicyBasedRoutingService

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

Parameters:

  • 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.



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/google/cloud/network_connectivity.rb', line 100

def self.policy_based_routing_service version: :v1, &block
  require "google/cloud/network_connectivity/#{version.to_s.downcase}"

  package_name = Google::Cloud::NetworkConnectivity
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::NetworkConnectivity.const_get(package_name).const_get(:PolicyBasedRoutingService)
  service_module.const_get(:Client).new(&block)
end