class Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client
Client
for the LookupService
service.
Service
Directory API for looking up service data at runtime.
Attributes
@private
Public Class Methods
Configure the LookupService
Client
class.
See {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all LookupService clients ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb, line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ServiceDirectory", "V1beta1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 15.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2] } default_config end yield @configure if block_given? @configure end
Create a new LookupService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the LookupService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb, line 114 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/servicedirectory/v1beta1/lookup_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @lookup_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the LookupService
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 {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb, line 93 def configure yield @config if block_given? @config end
Returns a {::Google::Cloud::ServiceDirectory::V1beta1::Service service} and its associated endpoints. Resolving a service is not considered an active developer method.
@overload resolve_service
(request, options = nil)
Pass arguments to `resolve_service` via a request object, either of type {::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest} or an equivalent Hash. @param request [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload resolve_service
(name: nil, max_endpoints: nil, endpoint_filter: nil)
Pass arguments to `resolve_service` 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). @param name [::String] Required. The name of the service to resolve. @param max_endpoints [::Integer] Optional. The maximum number of endpoints to return. Defaults to 25. Maximum is 100. If a value less than one is specified, the Default is used. If a value greater than the Maximum is specified, the Maximum is used. @param endpoint_filter [::String] Optional. The filter applied to the endpoints of the resolved service. General `filter` string syntax: `<field> <operator> <value> (<logical connector>)` * `<field>` can be `name`, `address`, `port`, or `metadata.<key>` for map field * `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:` means `HAS`, and is roughly the same as `=` * `<value>` must be the same data type as field * `<logical connector>` can be `AND`, `OR`, `NOT` Examples of valid filters: * `metadata.owner` returns endpoints that have a annotation with the key `owner`, this is the same as `metadata:owner` * `metadata.protocol=gRPC` returns endpoints that have key/value `protocol=gRPC` * `address=192.108.1.105` returns endpoints that have this address * `port>8080` returns endpoints that have port number larger than 8080 * `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c` returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not * `metadata.owner!=sd AND metadata.foo=bar` returns endpoints that have `owner` in annotation key but value is not `sd` AND have key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoint, it returns no results For more information about filtering, see [API Filtering](https://aip.dev/160).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb, line 221 def resolve_service request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.resolve_service.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ServiceDirectory::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.resolve_service.timeout, metadata: metadata, retry_policy: @config.rpcs.resolve_service.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lookup_service_stub.call_rpc :resolve_service, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end