google-cloud-recommendation_engine-v1beta1 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e2377d92d8484e0c3b8b35a66a5605a99ceffb3ffea0d9e8e1a4b77e1393ed'
-  data.tar.gz: 1e6a76567b169585cba863e867daf66b5b01aefa489668f473a69513359e50bb
+  metadata.gz: 97d63c8f98c3c4ecdfbbf93301cef165679d6be77d62256015857bf1e12712cf
+  data.tar.gz: d3906b8b4f0761fa89331fae7707398b3ab376fdaefcb218bdcab5965e36acb2
 SHA512:
-  metadata.gz: 2b4b56da37f5339f19e11cd415f155853f044c1a735fd1e26a5505cdabd218cb0ed9866b1c74c861d3484da80c05e4c4d99e943d5bad20b294066aad717fd542
-  data.tar.gz: 97dcd74fb093a6f5ea2011a5e82a4016510458dc7ed3734a0dbc17f1f1b5629d8d521945bb8c086e3d9449028170e6dddb60cacb821865d0acec5b3361cebef3
+  metadata.gz: 3f386f017411cc4e74cd72485464a826b96c97c3009ba4c14094758f4332a1c951793c48ab790b41425771ac596d7102e3954fe851af9169f2da25714de89649
+  data.tar.gz: b7904644ab34032d1b938b1ce21a126500e33a282e2dcf589154d29bd9a300395bd381938522afbec35b33125145405e9a087db29e0760f348ef021483dab94f

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-recommendation_engine-v1beta1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Credentials}):
 
-1. `RECOMMENDATION_ENGINE_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `RECOMMENDATION_ENGINE_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
+* `RECOMMENDATION_ENGINE_CREDENTIALS` - Path to JSON file, or JSON contents
+* `RECOMMENDATION_ENGINE_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/recommendation_engine/v1beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.
 
 ### 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/recommendation_engine/v1beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/recommendation_engine/v1beta1"

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/recommendation_engine/v1beta1"
 
 client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new
-request = my_create_request
+request = ::Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest.new # (request fields as keyword arguments...)
 response = client.create_catalog_item request
 ```
 

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]
@@ -67,50 +66,32 @@ module Google
 
                 default_config.rpcs.create_catalog_item.timeout = 600.0
                 default_config.rpcs.create_catalog_item.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.get_catalog_item.timeout = 600.0
                 default_config.rpcs.get_catalog_item.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.list_catalog_items.timeout = 600.0
                 default_config.rpcs.list_catalog_items.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.update_catalog_item.timeout = 600.0
                 default_config.rpcs.update_catalog_item.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.delete_catalog_item.timeout = 600.0
                 default_config.rpcs.delete_catalog_item.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.import_catalog_items.timeout = 600.0
                 default_config.rpcs.import_catalog_items.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -142,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]
@@ -174,14 +151,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
@@ -242,6 +218,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?
 
@@ -259,16 +250,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|
@@ -309,6 +304,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?
 
@@ -326,16 +336,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|
@@ -383,6 +397,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?
 
@@ -400,16 +435,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|
@@ -458,6 +497,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?
 
@@ -475,16 +529,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|
@@ -525,6 +583,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?
 
@@ -542,16 +615,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|
@@ -605,6 +682,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?
 
@@ -622,16 +721,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|
@@ -656,22 +759,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.