google-cloud-service_directory-v1beta1 0.7.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dbd5753cd1f9cdaa0ef5ea57d5c720ebc2731900c3224c9a4296bfb50a942b0
-  data.tar.gz: 42125fbf91f807801f8171b3424538221d4a713b5233ac8c75e49e946506d2ae
+  metadata.gz: f5a271b2f883314b663b13a50a4ee651d24d095b563754ef9151f4da36b62e16
+  data.tar.gz: 8f6dd6508066f7535cb0da0d0ea98bd3a23ebed348bd3a25d2c43019e300aef4
 SHA512:
-  metadata.gz: 878b03786e5fb06d9dd4a1e829759a5f24496f80c1a76cc020ef42455f6b7286a5258c200682b1d6aa4f1a760affeff10527322b169d0e56ef4f89a50f60887c
-  data.tar.gz: '03561611104928b7ff027601d15b442359344c18ed55985d4e8de01dbf974a4403a4fddbc8778334d982a127a0ba16a258421a6cb55520c5ae9bb3eaf182cacb'
+  metadata.gz: 81bea97ddbc9b9b5990a1b29f159ae23511ac5cee0552a3e4bbe5af0a8eb4131dbb7a6cbdcca28ed4a0408be3eb5991866ff54673fd24290c48103043bb12cd6
+  data.tar.gz: be0ffc3af76acc8eebc158efb4172dccb03b8a0672c1fe6e5c671744ff14257334a7bba210d801c3b278a7388b433fc0ce842c127ca81f3995908ad25b71dfb7

data/.yardopts

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

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ 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}):
 
-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/v1beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceDirectory::V1beta1::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/v1beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new d
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/service_directory/v1beta1"
@@ -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/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/v1beta1"
 
 client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
-request = my_create_request
+request = ::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest.new # (request fields as keyword arguments...)
 response = client.resolve_service request
 ```
 

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all LookupService clients:
-            #
-            #     ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # 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]
@@ -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::V1beta1::LookupService::Client.new
+            #   # Create a client using the default configuration
+            #   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.0
-            #     end
+            #   # 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]
@@ -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
@@ -227,6 +218,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/service_directory/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest.new
+            #
+            #   # Call the resolve_service method.
+            #   result = client.resolve_service request
+            #
+            #   # The returned object is of type Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse.
+            #   p result
+            #
             def resolve_service request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -244,16 +250,20 @@ module Google
                 gapic_version: ::Google::Cloud::ServiceDirectory::V1beta1::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|
@@ -277,22 +287,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::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.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::V1beta1::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::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.