google-cloud-recommendation_engine-v1beta1 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18034d005b58dc867dce5358c4bb055465a61adcbd37719e9931c6e6b4718faf
-  data.tar.gz: a7ae76acd6694f49e07212ece8a375cb65eaebc7efa5df9e27f0ece6608ae692
+  metadata.gz: 4aec482a16bd6c769e8f96f26b1b370797da150f28c3cd0ad359b4c8d223cc0c
+  data.tar.gz: 32a34716aa09bc233216112fa8c2111ee4c3f6c9136c2fce61f72ae9ab513bda
 SHA512:
-  metadata.gz: 97cf9761beb2520124a17dc9247ce77a290d78aee04c0db4a5d6d4a61f8dd5bb1d07a206f7245ef7ed22e8a7d99f9d8ed8d3b3cf21ff2915f40af0a716d44097
-  data.tar.gz: e8f83f6da6ce636e9a34c24c8a47fb1d2996f821959c23953dd501f893d9af3b2ab18a90941a881ef8fafb51a5e0c0d627d29b8603e05f68fc4129d46908d6e5
+  metadata.gz: 78e99c3ce43a1b972267f7b66a570bb24716821fd6497abb4bdf5f5ea6d90addf66b8f3220329e2bacf27bf7d9783cf464afbba739926830041989a57d5dcd94
+  data.tar.gz: afff6d63f2e5d3205f290c4fcc0fda77bfd0c419d6bc858fe7d6c47b880b7bcc9654e16b6c1d827b223cf65497b6db8c311ec1fc59fbdd2464f087b02266a44b

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Recommendations AI V1beta1 API
+--title="Recommendations AI V1beta1 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/recommendation_engine/v1beta1/catalog_service/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all CatalogService clients:
-            #
-            #     ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all CatalogService clients
+            #   ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -124,19 +123,15 @@ module Google
             ##
             # Create a new CatalogService client object.
             #
-            # ## Examples
-            #
-            # To create a new CatalogService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
             #
-            # To create a new CatalogService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the CatalogService client.
             # @yieldparam config [Client::Configuration]
@@ -156,10 +151,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
@@ -171,6 +165,7 @@ module Google
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
+                config.quota_project = @quota_project_id
                 config.endpoint = @config.endpoint
               end
 
@@ -224,6 +219,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest.new
+            #
+            #   # Call the create_catalog_item method.
+            #   result = client.create_catalog_item request
+            #
+            #   # The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
+            #   p result
+            #
             def create_catalog_item request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -241,16 +251,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.create_catalog_item.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_catalog_item.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :create_catalog_item, request, options: options do |response, operation|
@@ -291,6 +305,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest.new
+            #
+            #   # Call the get_catalog_item method.
+            #   result = client.get_catalog_item request
+            #
+            #   # The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
+            #   p result
+            #
             def get_catalog_item request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -308,16 +337,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::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.get_catalog_item.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_catalog_item.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :get_catalog_item, request, options: options do |response, operation|
@@ -365,6 +398,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest.new
+            #
+            #   # Call the list_catalog_items method.
+            #   result = client.list_catalog_items request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
+            #     p response
+            #   end
+            #
             def list_catalog_items request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -382,16 +436,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.list_catalog_items.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_catalog_items.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :list_catalog_items, request, options: options do |response, operation|
@@ -440,6 +498,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest.new
+            #
+            #   # Call the update_catalog_item method.
+            #   result = client.update_catalog_item request
+            #
+            #   # The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
+            #   p result
+            #
             def update_catalog_item request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -457,16 +530,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::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.update_catalog_item.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_catalog_item.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :update_catalog_item, request, options: options do |response, operation|
@@ -507,6 +584,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest.new
+            #
+            #   # Call the delete_catalog_item method.
+            #   result = client.delete_catalog_item request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_catalog_item request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -524,16 +616,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::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.delete_catalog_item.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_catalog_item.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :delete_catalog_item, request, options: options do |response, operation|
@@ -587,6 +683,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommendation_engine/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest.new
+            #
+            #   # Call the import_catalog_items method.
+            #   result = client.import_catalog_items request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def import_catalog_items request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -604,16 +722,20 @@ module Google
                 gapic_version: ::Google::Cloud::RecommendationEngine::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.import_catalog_items.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.import_catalog_items.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @catalog_service_stub.call_rpc :import_catalog_items, request, options: options do |response, operation|
@@ -638,22 +760,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 create_catalog_item
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_catalog_item.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_catalog_item.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # create_catalog_item to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_catalog_item.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_catalog_item.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.