Module: Google::Cloud::NetworkManagement

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

Constant Summary collapse

VERSION = 
"1.4.1"

Class Method Summary collapse

Class Method Details

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

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



117
118
119
120
121
 
# File 'lib/google/cloud/network_management.rb', line 117

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

  ::Google::Cloud.configure.network_management
end

.reachability_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ReachabilityService.

By default, this returns an instance of Google::Cloud::NetworkManagement::V1::ReachabilityService::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 ReachabilityService 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.

About ReachabilityService

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

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.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/network_management.rb', line 77

def self.reachability_service version: :v1, transport: :grpc, &block
  require "google/cloud/network_management/#{version.to_s.downcase}"

  package_name = Google::Cloud::NetworkManagement
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::NetworkManagement.const_get(package_name).const_get(:ReachabilityService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end