google-cloud-service_directory-v1 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0222cd31287ee425eb3ee5cff0d991fdb3c4b299ef259158063bbc7eb81c0018
-  data.tar.gz: dfbc5981b4cfa8dfbf9191915f4c24fff0552db9e2219aa55bc94463f7582a57
+  metadata.gz: add551a374838cea816f62ca5128c16f23f5913e455ae84915417ec93daebd1b
+  data.tar.gz: 26b37e7584b78c5ff230ac65cde679906fcdc13bfe4471e185c48ba51ed5db1a
 SHA512:
-  metadata.gz: 688405fecec04431d59e3a9f82aca0b9c1f1dc207b7a8951c5b0d1816b35b59fb43725f11afb0bc30e4c9dc20066095ed3a6ba7470c5bcd11d9c1b04c27128fa
-  data.tar.gz: dfcb0196b7f616bae82f76993de6a31cc1f9ed743eb334f7d050fb0eec7d7a658e9a1876b63b35759f4eee7cb5cf9de8ab4af29e754653f16910dd14a8d68b53
+  metadata.gz: 9c6252683a0cb8e7bd700569013193ab7169e7b8ddbac3fbe3b784fdc23cc6b56c2232d5df541bbe60d5c72c4229b2049e4a114ce858c5124a7e1a8ad9c875db
+  data.tar.gz: 2073cd1daf9680f1ed8aecf7a7fc9836a53e09476cc013ee7bb1d191f9a4c6fb664cc53c4945fe508c870eac18840143352e4d18f2d32688ba17295ff822a925

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Service Directory V1 API
+--title="Service Directory V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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]
@@ -99,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]
@@ -131,10 +126,9 @@ 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
@@ -209,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?
 
@@ -226,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|
@@ -259,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.