Module: Google::Cloud::ServiceDirectory

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

Constant Summary collapse

VERSION = 
"1.5.1".freeze

Class Method Summary collapse

Class Method Details

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

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



158
159
160
161
162
 
# File 'lib/google/cloud/service_directory.rb', line 158

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

  ::Google::Cloud.configure.service_directory
end

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

Create a new client object for LookupService.

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

Service Directory API for looking up service data at runtime.

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.



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

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

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

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

Create a new client object for RegistrationService.

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

Service Directory API for registering services. It defines the following resource model:

  • The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.

  • Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.

  • Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

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.



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/cloud/service_directory.rb', line 118

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

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