google-cloud-service_directory-v1beta1 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1234c2fd6eff8256982a3f0d178667c252c79be0c0708f49b428032eff575176
-  data.tar.gz: 38546b6494c58faf2e941361f711057659b8051f68c2b5702c8f32d2118c616e
+  metadata.gz: 3587b7154b0e2392d1ad07b08191fd51be0204a0e17d7f1c7b9195971fc8ea1e
+  data.tar.gz: 7aad35668a27973db11968c132ddeba07091fa93000c1d18aae348605e17f4e8
 SHA512:
-  metadata.gz: e49d45b34411d891ec40413e6a63190612f8b3af516f16f286fb48c5491ebf8ffc0ff73434f44d9dffa5c1c028a3d856bdbad2c9521cde77c3b3e692e512cd57
-  data.tar.gz: d1b34445a6be72e10b897b121d7c5ad142c7feb3451ff89702fe81998e62f6adb3a2afdfa2bcb4ce2e45cbca39d4542486dae92762093d1207c9940a0a13065b
+  metadata.gz: e4040bab0f7cd93cdf004e9574eee8c68dff6eaa411995606ad462536c3ec0382bc6a51099bf2d16bcf84cfd10f103a13e061877faf7b4d092ffc3a6ec619470
+  data.tar.gz: a27afe807ee820954f20d9b0a35192d656b2c218e8a79a51d1c9f2e4cb79ac00562829e1c091549ad9574ee599f2789b961c67bfc66be4f699b8169d38241c2c

data/AUTHENTICATION.md

@@ -27,7 +27,7 @@ export SERVICE_DIRECTORY_CREDENTIALS=path/to/keyfile.json
 ```ruby
 require "google/cloud/service_directory/v1beta1"
 
-client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
 ```
 
 ## Credential Lookup
@@ -64,7 +64,7 @@ containers where writing files is difficult or not encouraged.
 
 The environment variables that google-cloud-service_directory-v1beta1
 checks for credentials are configured on the service Credentials class (such as
-{Google::Cloud::ServiceDirectory::V1beta1::LookupService::Credentials}):
+{::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Credentials}):
 
 1. `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
@@ -77,7 +77,7 @@ require "google/cloud/service_directory/v1beta1"
 
 ENV["SERVICE_DIRECTORY_CREDENTIALS"] = "path/to/keyfile.json"
 
-client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
 ```
 
 ### Configuration
@@ -88,7 +88,7 @@ environment variables. Either on an individual client initialization:
 ```ruby
 require "google/cloud/service_directory/v1beta1"
 
-client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
+client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
   config.credentials = "path/to/keyfile.json"
 end
 ```
@@ -98,11 +98,11 @@ Or configured globally for all clients:
 ```ruby
 require "google/cloud/service_directory/v1beta1"
 
-Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
+::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
 ```
 
 ### Cloud SDK

data/README.md

@@ -1,4 +1,4 @@
-# Service Directory V1beta1
+# Ruby Client for the Service Directory V1beta1 API
 
 API Client library for the Service Directory V1beta1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-service_directory-v1beta1
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/service_directory/v1beta1"
+
+client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+request = my_create_request
+response = client.resolve_service request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-service_directory-v1beta1/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/lib/google-cloud-service_directory-v1beta1.rb

@@ -1 +1,21 @@
-require "google/cloud/service_directory/v1beta1/version"
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/service_directory/v1beta1"

data/lib/google/cloud/service_directory/v1beta1.rb

@@ -18,3 +18,19 @@
 
 require "google/cloud/service_directory/v1beta1/lookup_service"
 require "google/cloud/service_directory/v1beta1/registration_service"
+require "google/cloud/service_directory/v1beta1/version"
+
+module Google
+  module Cloud
+    module ServiceDirectory
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/service_directory/v1beta1"
+      #     client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+      #
+      module V1beta1
+      end
+    end
+  end
+end

data/lib/google/cloud/service_directory/v1beta1/lookup_service.rb

@@ -16,5 +16,34 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/service_directory/v1beta1/lookup_service/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/service_directory/v1beta1/version"
+
 require "google/cloud/service_directory/v1beta1/lookup_service/credentials"
+require "google/cloud/service_directory/v1beta1/lookup_service/paths"
+require "google/cloud/service_directory/v1beta1/lookup_service/client"
+
+module Google
+  module Cloud
+    module ServiceDirectory
+      module V1beta1
+        ##
+        # Service Directory API for looking up service data at runtime.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/service_directory/v1beta1/lookup_service"
+        #     client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+        #
+        module LookupService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "lookup_service", "helpers.rb"
+require "google/cloud/service_directory/v1beta1/lookup_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/service_directory/v1beta1/version"
 require "google/cloud/servicedirectory/v1beta1/lookup_service_pb"
-require "google/cloud/service_directory/v1beta1/lookup_service/credentials"
-require "google/cloud/service_directory/v1beta1/lookup_service/paths"
 
 module Google
   module Cloud
@@ -45,15 +38,15 @@ module Google
             ##
             # Configure the LookupService Client class.
             #
-            # See {Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration}
+            # See {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration}
             # for a description of the configuration fields.
             #
             # ## Example
             #
             # To modify the configuration for all LookupService clients:
             #
-            #     Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
-            #       config.timeout = 10_000
+            #     ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
+            #       config.timeout = 10.0
             #     end
             #
             # @yield [config] Configure the Client client.
@@ -93,7 +86,7 @@ module Google
             # 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}
+            # See {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration}
             # for a description of the configuration fields.
             #
             # @yield [config] Configure the Client client.
@@ -114,13 +107,13 @@ module Google
             # To create a new LookupService client with the default
             # configuration:
             #
-            #     client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+            #     client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
             #
             # To create a new LookupService client with a custom
             # configuration:
             #
-            #     client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
-            #       config.timeout = 10_000
+            #     client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
+            #       config.timeout = 10.0
             #     end
             #
             # @yield [config] Configure the LookupService client.
@@ -145,10 +138,11 @@ module Google
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
-              @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+              @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,
+              @lookup_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Stub,
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
@@ -159,26 +153,32 @@ module Google
             # Service calls
 
             ##
-            # Returns a {Google::Cloud::ServiceDirectory::V1beta1::Service service} and its
+            # 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)
-            #   @param request [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest | Hash]
-            #     Returns a {Google::Cloud::ServiceDirectory::V1beta1::Service service} and its
-            #     associated endpoints.
-            #     Resolving a service is not considered an active developer method.
-            #   @param options [Gapic::CallOptions, Hash]
+            #   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)
-            #   @param name [String]
+            #   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]
+            #   @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]
+            #   @param endpoint_filter [::String]
             #     Optional. The filter applied to the endpoints of the resolved service.
             #
             #     General filter string syntax:
@@ -198,28 +198,27 @@ module Google
             #       Endpoints that have "owner" field in metadata with a value that is not
             #       "sd" AND have the key/value foo=bar.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
-            # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
-            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @yieldparam response [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
-            # @return [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
+            # @return [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
             #
-            # @raise [Google::Cloud::Error] if the RPC is aborted.
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
             def resolve_service request, options = nil
-              raise ArgumentError, "request must be provided" if request.nil?
+              raise ::ArgumentError, "request must be provided" if request.nil?
 
-              request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest
+              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
+              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 \
+              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
@@ -240,8 +239,8 @@ module Google
                 yield response, operation if block_given?
                 return response
               end
-            rescue GRPC::BadStatus => e
-              raise Google::Cloud::Error.from_error(e)
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
             end
 
             ##
@@ -251,7 +250,7 @@ module Google
             # providing control over timeouts, retry behavior, logging, transport
             # parameters, and other low-level controls. Certain parameters can also be
             # applied individually to specific RPCs. See
-            # {Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration::Rpcs}
+            # {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration::Rpcs}
             # for a list of RPCs that can be configured independently.
             #
             # Configuration can be applied globally to all clients, or to a single client
@@ -262,22 +261,22 @@ module Google
             # To modify the global config, setting the timeout for resolve_service
             # to 20 seconds, and all remaining timeouts to 10 seconds:
             #
-            #     Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
-            #       config.timeout = 10_000
-            #       config.rpcs.resolve_service.timeout = 20_000
+            #     ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.resolve_service.timeout = 20.0
             #     end
             #
             # To apply the above configuration only to a new client:
             #
-            #     client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
-            #       config.timeout = 10_000
-            #       config.rpcs.resolve_service.timeout = 20_000
+            #     client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.resolve_service.timeout = 20.0
             #     end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.
             #   Defaults to `"servicedirectory.googleapis.com"`.
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
             #    *  (`String`) The path to a service account key file in JSON format
@@ -289,29 +288,29 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
-            #   @return [Object]
+            #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
-            #   @return [Array<String>]
+            #   @return [::Array<::String>]
             # @!attribute [rw] lib_name
             #   The library name as recorded in instrumentation and logging
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] lib_version
             #   The library version as recorded in instrumentation and logging
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] channel_args
             #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
             #   `GRPC::Core::Channel` object is provided as the credential.
-            #   @return [Hash]
+            #   @return [::Hash]
             # @!attribute [rw] interceptors
             #   An array of interceptors that are run before calls are executed.
-            #   @return [Array<GRPC::ClientInterceptor>]
+            #   @return [::Array<::GRPC::ClientInterceptor>]
             # @!attribute [rw] timeout
-            #   The call timeout in milliseconds.
-            #   @return [Numeric]
+            #   The call timeout in seconds.
+            #   @return [::Numeric]
             # @!attribute [rw] metadata
             #   Additional gRPC headers to be sent with the call.
-            #   @return [Hash{Symbol=>String}]
+            #   @return [::Hash{::Symbol=>::String}]
             # @!attribute [rw] retry_policy
             #   The retry policy. The value is a hash with the following keys:
             #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
@@ -319,25 +318,29 @@ module Google
             #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
             #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
             #       trigger a retry.
-            #   @return [Hash]
+            #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
             #
             class Configuration
-              extend Gapic::Config
+              extend ::Gapic::Config
 
-              config_attr :endpoint,     "servicedirectory.googleapis.com", String
-              config_attr :credentials,  nil do |value|
+              config_attr :endpoint,      "servicedirectory.googleapis.com", ::String
+              config_attr :credentials,   nil do |value|
                 allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
-              config_attr :scope,        nil, String, Array, nil
-              config_attr :lib_name,     nil, String, nil
-              config_attr :lib_version,  nil, String, nil
-              config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, Hash, nil)
-              config_attr :interceptors, nil, Array, nil
-              config_attr :timeout,      nil, Numeric, nil
-              config_attr :metadata,     nil, Hash, nil
-              config_attr :retry_policy, nil, Hash, Proc, nil
+              config_attr :scope,         nil, ::String, ::Array, nil
+              config_attr :lib_name,      nil, ::String, nil
+              config_attr :lib_version,   nil, ::String, nil
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr :interceptors,  nil, ::Array, nil
+              config_attr :timeout,       nil, ::Numeric, nil
+              config_attr :metadata,      nil, ::Hash, nil
+              config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+              config_attr :quota_project, nil, ::String, nil
 
               # @private
               def initialize parent_config = nil
@@ -378,14 +381,14 @@ module Google
               class Rpcs
                 ##
                 # RPC-specific configuration for `resolve_service`
-                # @return [Gapic::Config::Method]
+                # @return [::Gapic::Config::Method]
                 #
                 attr_reader :resolve_service
 
                 # @private
                 def initialize parent_rpcs = nil
                   resolve_service_config = parent_rpcs&.resolve_service if parent_rpcs&.respond_to? :resolve_service
-                  @resolve_service = Gapic::Config::Method.new resolve_service_config
+                  @resolve_service = ::Gapic::Config::Method.new resolve_service_config
 
                   yield self if block_given?
                 end
@@ -397,13 +400,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/service_directory/v1beta1/lookup_service/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions