google-cloud-recommendation_engine-v1beta1 0.1.1 → 0.3.3

data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/client.rb

@@ -60,49 +60,34 @@ module Google
                 parent_config = while namespace.any?
                                   parent_name = namespace.join "::"
                                   parent_const = const_get parent_name
-                                  break parent_const.configure if parent_const&.respond_to? :configure
+                                  break parent_const.configure if parent_const.respond_to? :configure
                                   namespace.pop
                                 end
                 default_config = Client::Configuration.new parent_config
 
                 default_config.rpcs.write_user_event.timeout = 600.0
                 default_config.rpcs.write_user_event.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.collect_user_event.timeout = 600.0
                 default_config.rpcs.collect_user_event.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_user_events.timeout = 600.0
                 default_config.rpcs.list_user_events.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.purge_user_events.timeout = 600.0
                 default_config.rpcs.purge_user_events.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_user_events.timeout = 600.0
                 default_config.rpcs.import_user_events.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
@@ -166,8 +151,14 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              # Use self-signed JWT if the scope and endpoint are 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 &&
+                                       !@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)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -216,7 +207,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The parent eventStore resource name, such as
-            #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
+            #     `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
             #   @param user_event [::Google::Cloud::RecommendationEngine::V1beta1::UserEvent, ::Hash]
             #     Required. User event to write.
             #
@@ -289,7 +280,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The parent eventStore name, such as
-            #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
+            #     `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
             #   @param user_event [::String]
             #     Required. URL encoded UserEvent proto.
             #   @param uri [::String]
@@ -367,7 +358,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The parent eventStore resource name, such as
-            #     "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
+            #     `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.
             #   @param page_size [::Integer]
             #     Optional. Maximum number of results to return per page. If zero, the
             #     service will choose a reasonable default.
@@ -477,7 +468,7 @@ module Google
             #   @param parent [::String]
             #     Required. The resource name of the event_store under which the events are
             #     created. The format is
-            #     "projects/$\\{projectId}/locations/global/catalogs/$\\{catalogId}/eventStores/$\\{eventStoreId}"
+            #     `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
             #   @param filter [::String]
             #     Required. The filter string to specify the events to be deleted. Empty
             #     string filter is not allowed. This filter can also be used with
@@ -574,7 +565,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required.
-            #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
+            #     `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
             #   @param request_id [::String]
             #     Optional. Unique identifier provided by client, within the ancestor
             #     dataset scope. Ensures idempotency for expensive long running operations.
@@ -725,7 +716,7 @@ module Google
               config_attr :scope,         nil, ::String, ::Array, nil
               config_attr :lib_name,      nil, ::String, nil
               config_attr :lib_version,   nil, ::String, nil
-              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
               config_attr :interceptors,  nil, ::Array, nil
               config_attr :timeout,       nil, ::Numeric, nil
               config_attr :metadata,      nil, ::Hash, nil
@@ -746,7 +737,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -797,15 +788,15 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
-                  write_user_event_config = parent_rpcs&.write_user_event if parent_rpcs&.respond_to? :write_user_event
+                  write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
                   @write_user_event = ::Gapic::Config::Method.new write_user_event_config
-                  collect_user_event_config = parent_rpcs&.collect_user_event if parent_rpcs&.respond_to? :collect_user_event
+                  collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
                   @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
-                  list_user_events_config = parent_rpcs&.list_user_events if parent_rpcs&.respond_to? :list_user_events
+                  list_user_events_config = parent_rpcs.list_user_events if parent_rpcs.respond_to? :list_user_events
                   @list_user_events = ::Gapic::Config::Method.new list_user_events_config
-                  purge_user_events_config = parent_rpcs&.purge_user_events if parent_rpcs&.respond_to? :purge_user_events
+                  purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
                   @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
-                  import_user_events_config = parent_rpcs&.import_user_events if parent_rpcs&.respond_to? :import_user_events
+                  import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
                   @import_user_events = ::Gapic::Config::Method.new import_user_events_config
 
                   yield self if block_given?

data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/operations.rb

@@ -82,7 +82,7 @@ module Google
               # Create credentials
               credentials = @config.credentials
               credentials ||= Credentials.default scope: @config.scope
-              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
@@ -103,8 +103,13 @@ module Google
             # Lists operations that match the specified filter in the request. If the
             # server doesn't support this method, it returns `UNIMPLEMENTED`.
             #
-            # NOTE: the `name` binding below allows API services to override the binding
-            # to use different resource name schemes, such as `users/*/operations`.
+            # NOTE: the `name` binding allows API services to override the binding
+            # to use different resource name schemes, such as `users/*/operations`. To
+            # override the binding, API services can add a binding such as
+            # `"/v1/{name=users/*}/operations"` to their service configuration.
+            # For backwards compatibility, the default name includes the operations
+            # collection id, however overriding users must ensure the name binding
+            # is the parent resource, without the operations collection id.
             #
             # @overload list_operations(request, options = nil)
             #   Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     The name of the operation collection.
+            #     The name of the operation's parent resource.
             #   @param filter [::String]
             #     The standard list filter.
             #   @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Waits until the specified long-running operation is done or reaches at most
+            # a specified timeout, returning the latest state.  If the operation is
+            # already done, the latest state is immediately returned.  If the timeout
+            # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+            # timeout is used.  If the server does not support this method, it returns
+            # `google.rpc.Code.UNIMPLEMENTED`.
+            # Note that this method is on a best-effort basis.  It may return the latest
+            # state before the specified timeout (including immediately), meaning even an
+            # immediate response is no guarantee that the operation is done.
+            #
+            # @overload wait_operation(request, options = nil)
+            #   Pass arguments to `wait_operation` via a request object, either of type
+            #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload wait_operation(name: nil, timeout: nil)
+            #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     The name of the operation resource to wait on.
+            #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+            #     The maximum duration to wait before timing out. If left blank, the wait
+            #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+            #     If RPC context deadline is also specified, the shorter one will be used.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def wait_operation request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.wait_operation.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::RecommendationEngine::V1beta1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.wait_operation.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the Operations API.
             #
@@ -482,7 +560,7 @@ module Google
               config_attr :scope,         nil, ::String, ::Array, nil
               config_attr :lib_name,      nil, ::String, nil
               config_attr :lib_version,   nil, ::String, nil
-              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
               config_attr :interceptors,  nil, ::Array, nil
               config_attr :timeout,       nil, ::Numeric, nil
               config_attr :metadata,      nil, ::Hash, nil
@@ -503,7 +581,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -546,17 +624,24 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :cancel_operation
+                ##
+                # RPC-specific configuration for `wait_operation`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :wait_operation
 
                 # @private
                 def initialize parent_rpcs = nil
-                  list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
+                  list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
                   @list_operations = ::Gapic::Config::Method.new list_operations_config
-                  get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
+                  get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
                   @get_operation = ::Gapic::Config::Method.new get_operation_config
-                  delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
+                  delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
                   @delete_operation = ::Gapic::Config::Method.new delete_operation_config
-                  cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
+                  cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
                   @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                  wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
+                  @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/recommendation_engine/v1beta1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module RecommendationEngine
       module V1beta1
-        VERSION = "0.1.1"
+        VERSION = "0.3.3"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,18 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/api/httpbody.rb

@@ -43,7 +43,8 @@ module Google
     #
     #     service ResourceService {
     #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
-    #       rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
+    #       rpc UpdateResource(google.api.HttpBody) returns
+    #       (google.protobuf.Empty);
     #     }
     #
     # Example with streaming methods:
@@ -59,10 +60,10 @@ module Google
     # handled, all other features will continue to work unchanged.
     # @!attribute [rw] content_type
     #   @return [::String]
-    #     The HTTP Content-Type string representing the content type of the body.
+    #     The HTTP Content-Type header value specifying the content type of the body.
     # @!attribute [rw] data
     #   @return [::String]
-    #     HTTP body binary data.
+    #     The HTTP request/response body as raw binary.
     # @!attribute [rw] extensions
     #   @return [::Array<::Google::Protobuf::Any>]
     #     Application specific response metadata. Must be set in the first response

data/proto_docs/google/cloud/recommendationengine/v1beta1/catalog_service.rb

@@ -25,7 +25,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog resource name, such as
-        #     "projects/*/locations/global/catalogs/default_catalog".
+        #     `projects/*/locations/global/catalogs/default_catalog`.
         # @!attribute [rw] catalog_item
         #   @return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
         #     Required. The catalog item to create.
@@ -38,7 +38,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Full resource name of catalog item, such as
-        #     "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
+        #     `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
         class GetCatalogItemRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,7 +48,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog resource name, such as
-        #     "projects/*/locations/global/catalogs/default_catalog".
+        #     `projects/*/locations/global/catalogs/default_catalog`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return per page. If zero, the
@@ -99,7 +99,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Full resource name of catalog item, such as
-        #     "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
+        #     `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
         class DeleteCatalogItemRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/recommendationengine/v1beta1/import.rb

@@ -27,8 +27,8 @@ module Google
         #   @return [::Array<::String>]
         #     Required. Google Cloud Storage URIs to input files. URI can be up to
         #     2000 characters long. URIs can match the full object path (for example,
-        #     gs://bucket/directory/object.json) or a pattern matching one or more
-        #     files, such as gs://bucket/directory/*.json. A request can
+        #     `gs://bucket/directory/object.json`) or a pattern matching one or more
+        #     files, such as `gs://bucket/directory/*.json`. A request can
         #     contain at most 100 files, and each file can be up to 2 GB. See
         #     [Importing catalog information](/recommendations-ai/docs/upload-catalog)
         #     for the expected file format and setup instructions.
@@ -71,7 +71,7 @@ module Google
         # Request message for Import methods.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. "projects/1234/locations/global/catalogs/default_catalog"
+        #     Required. `projects/1234/locations/global/catalogs/default_catalog`
         # @!attribute [rw] request_id
         #   @return [::String]
         #     Optional. Unique identifier provided by client, within the ancestor
@@ -93,7 +93,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required.
-        #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
+        #     `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
         # @!attribute [rw] request_id
         #   @return [::String]
         #     Optional. Unique identifier provided by client, within the ancestor

data/proto_docs/google/cloud/recommendationengine/v1beta1/prediction_apikey_registry_service.rb

@@ -34,7 +34,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource path.
-        #     "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
+        #     `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
         # @!attribute [rw] prediction_api_key_registration
         #   @return [::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration]
         #     Required. The prediction API key registration.
@@ -47,7 +47,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent placement resource name such as
-        #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
+        #     `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return per page. If unset, the
@@ -77,7 +77,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The API key to unregister including full resource path.
-        #     "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
+        #     `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>`
         class DeletePredictionApiKeyRegistrationRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods