google-cloud-retail-v2 0.1.1 → 0.3.2

data/lib/google/cloud/retail/v2/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::Retail::V2::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/retail/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.1.1"
+        VERSION = "0.3.2"
       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/retail/v2/import_config.rb

@@ -27,10 +27,11 @@ 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 product information](/recommendations-ai/docs/upload-catalog)
+        #     [Importing product
+        #     information](https://cloud.google.com/recommendations-ai/docs/upload-catalog)
         #     for the expected file format and setup instructions.
         # @!attribute [rw] data_schema
         #   @return [::String]
@@ -42,7 +43,7 @@ module Google
         #     per line. Each product must
         #       have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
         #     * `product_merchant_center`: See [Importing catalog data from Merchant
-        #       Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+        #       Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
         #
         #     Supported values for user events imports:
         #
@@ -84,7 +85,7 @@ module Google
         #     per line. Each product must
         #       have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
         #     * `product_merchant_center`: See [Importing catalog data from Merchant
-        #       Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+        #       Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
         #
         #     Supported values for user events imports:
         #
@@ -133,7 +134,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required.
-        #     "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch"
+        #     `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`
         #
         #     If no updateMask is specified, requires products.create permission.
         #     If updateMask is specified, requires products.update permission.
@@ -155,7 +156,7 @@ module Google
         # Request message for the ImportUserEvents request.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. "projects/1234/locations/global/catalogs/default_catalog"
+        #     Required. `projects/1234/locations/global/catalogs/default_catalog`
         # @!attribute [rw] input_config
         #   @return [::Google::Cloud::Retail::V2::UserEventInputConfig]
         #     Required. The desired input location of the data.

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -26,7 +26,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Full resource name of the product, such as
-        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id".
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
         #
         #     The branch ID must be "default_branch".
         # @!attribute [rw] id
@@ -35,7 +35,7 @@ module Google
         #     the final component of {::Google::Cloud::Retail::V2::Product#name name}. For
         #     example, this field is "id_1", if
         #     {::Google::Cloud::Retail::V2::Product#name name} is
-        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1".
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.
         #
         #     This field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.

data/proto_docs/google/cloud/retail/v2/product_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/branches/default_branch".
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
         # @!attribute [rw] product
         #   @return [::Google::Cloud::Retail::V2::Product]
         #     Required. The {::Google::Cloud::Retail::V2::Product Product} to create.
@@ -56,7 +56,7 @@ module Google
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
         #     such as
-        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
         #
         #     If the caller does not have permission to access the
         #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
@@ -99,7 +99,7 @@ module Google
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
         #     such as
-        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
         #
         #     If the caller does not have permission to delete the
         #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it

data/proto_docs/google/cloud/retail/v2/user_event_service.rb

@@ -25,7 +25,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog resource name, such as
-        #     "projects/1234/locations/global/catalogs/default_catalog".
+        #     `projects/1234/locations/global/catalogs/default_catalog`.
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::Retail::V2::UserEvent]
         #     Required. User event to write.
@@ -38,7 +38,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog name, such as
-        #     "projects/1234/locations/global/catalogs/default_catalog".
+        #     `projects/1234/locations/global/catalogs/default_catalog`.
         # @!attribute [rw] user_event
         #   @return [::String]
         #     Required. URL encoded UserEvent proto with a length limit of 2,000,000
@@ -63,7 +63,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog resource name, such as
-        #     "projects/1234/locations/global/catalogs/default_catalog".
+        #     `projects/1234/locations/global/catalogs/default_catalog`.
         # @!attribute [rw] user_event_rejoin_scope
         #   @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
         #     The type of the user event rejoin to define the scope and range of the user

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     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.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end