google-cloud-service_directory-v1 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe20807609fe425e1bc2c7e6a9595f782fa18cd93d2e8e970100364cbe68dce
-  data.tar.gz: ebe32959d19d9c1668fcada63fa1e5b74547fad95ed2da2883756886b115537a
+  metadata.gz: 9d078c7a6da36bf31a86f06b74a96977feb9146eb9107210c3a86ff5442add5b
+  data.tar.gz: 5a12da3c1533c334d4899cb4be95e516e5a83ae9961beefb698faa9be6e19657
 SHA512:
-  metadata.gz: eef2068a3875d5ce4a185379f23aadc47fb171986ce3bf326d43193572533fd109fd555b255b1b6290c91b70f51f6547fa145d712a44be6f186bbcc479b5d3b3
-  data.tar.gz: eebfba4dde7eafe74cad10904b2dd8ebf32ce947704f75221af61b89e76a5766f45ebd83371ad0a65fafd4ca20efcc0677c3bd9d6ad0bac98c0d6cf642622cab
+  metadata.gz: 6e4b9ae76eadf6dac1fdbb66734900293fb2d1939a46465ba259478899189c3d0d0c2815f2b5b0c9a9288bcb3de48fc5489a325a300034fa93fac2c8915be1a8
+  data.tar.gz: b1c39fe057a274293dd19ee1ac639d058ca929a27a0482e97876eced2a5f75d59d2dac108c35b79c178e8ff33b6ea5308f2888b6c61937b0d8edc13de36f8c13

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-service_directory-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::ServiceDirectory::V1::LookupService::Credentials}):
 
-1. `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
+* `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/service_directory/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/service_directory/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new do |co
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/service_directory/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/service_directory/v1"
 
 client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new
-request = my_create_request
+request = ::Google::Cloud::ServiceDirectory::V1::ResolveServiceRequest.new # (request fields as keyword arguments...)
 response = client.resolve_service request
 ```
 

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::ServiceDirectory::V1::LookupService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all LookupService clients:
-            #
-            #     ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all LookupService clients
+            #   ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -67,10 +66,7 @@ module Google
 
                 default_config.timeout = 15.0
                 default_config.retry_policy = {
-                  initial_delay: 1.0,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14, 2]
+                  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
                 }
 
                 default_config
@@ -102,19 +98,15 @@ module Google
             ##
             # Create a new LookupService client object.
             #
-            # ## Examples
-            #
-            # To create a new LookupService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new
             #
-            # To create a new LookupService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the LookupService client.
             # @yieldparam config [Client::Configuration]
@@ -134,14 +126,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # 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.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              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)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -212,6 +203,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/service_directory/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ServiceDirectory::V1::LookupService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ServiceDirectory::V1::ResolveServiceRequest.new
+            #
+            #   # Call the resolve_service method.
+            #   result = client.resolve_service request
+            #
+            #   # The returned object is of type Google::Cloud::ServiceDirectory::V1::ResolveServiceResponse.
+            #   p result
+            #
             def resolve_service request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -229,16 +235,20 @@ module Google
                 gapic_version: ::Google::Cloud::ServiceDirectory::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               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 metadata:     @config.metadata,
+
+              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|
@@ -262,22 +272,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for resolve_service
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::ServiceDirectory::V1::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::V1::LookupService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.resolve_service.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # resolve_service to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::ServiceDirectory::V1::LookupService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.resolve_service.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::ServiceDirectory::V1::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.