RubyGems - google-cloud-discovery_engine-v1 - Versions diffs - 0.7.0 → 0.8.0 - Mend

google-cloud-discovery_engine-v1 0.7.0 → 0.8.0

Files changed (123) hide show

data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb CHANGED Viewed

@@ -33,6 +33,9 @@ module Google
             # Service for managing site search related resources.
             #
             class Client
+              # @private
+              API_VERSION = ""
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
@@ -244,12 +247,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get_site_search_engine.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.get_site_search_engine.timeout,
@@ -334,12 +338,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.create_target_site.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.create_target_site.timeout,
@@ -427,12 +432,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.batch_create_target_sites.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.batch_create_target_sites.timeout,
@@ -515,12 +521,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get_target_site.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.get_target_site.timeout,
@@ -606,12 +613,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.update_target_site.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.update_target_site.timeout,
@@ -701,12 +709,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete_target_site.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.delete_target_site.timeout,
@@ -802,12 +811,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list_target_sites.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.list_target_sites.timeout,
@@ -891,12 +901,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.enable_advanced_site_search.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.enable_advanced_site_search.timeout,
@@ -980,12 +991,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.disable_advanced_site_search.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.disable_advanced_site_search.timeout,
@@ -1073,12 +1085,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.recrawl_uris.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.recrawl_uris.timeout,
@@ -1162,12 +1175,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.batch_verify_target_sites.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.batch_verify_target_sites.timeout,
@@ -1262,12 +1276,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.fetch_domain_verification_status.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.fetch_domain_verification_status.timeout,

data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb CHANGED Viewed

@@ -26,6 +26,9 @@ module Google
           module Rest
             # Service that implements Longrunning Operations API.
             class Operations
+              # @private
+              API_VERSION = ""
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
@@ -181,12 +184,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list_operations.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
@@ -269,12 +273,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get_operation.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
@@ -351,12 +356,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete_operation.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
@@ -438,12 +444,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.cancel_operation.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
@@ -1077,7 +1084,23 @@ module Google
                                                           uri_template: "/v1/{name}:cancel",
                                                           body: "*",
                                                           matches: [
-                                                            ["name", %r{^operations(?:/.*)?$}, true]
+                                                            ["name", %r{^projects/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{name}:cancel",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{name}:cancel",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
                 transcoder.transcode request_pb

data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb CHANGED Viewed

@@ -31,6 +31,9 @@ module Google
           # Service for ingesting end user actions on a website to Discovery Engine API.
           #
           class Client
+            # @private
+            API_VERSION = ""
             # @private
             DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
@@ -212,16 +215,27 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload write_user_event(parent: nil, user_event: nil)
+            # @overload write_user_event(parent: nil, user_event: nil, write_async: nil)
             #   Pass arguments to `write_user_event` 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 parent [::String]
-            #     Required. The parent DataStore resource name, such as
+            #     Required. The parent resource name.
+            #     If the write user event action is applied in
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} level, the format
+            #     is:
             #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+            #     If the write user event action is applied in [Location][] level, for
+            #     example, the event with
+            #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, the format is:
+            #     `projects/{project}/locations/{location}`.
             #   @param user_event [::Google::Cloud::DiscoveryEngine::V1::UserEvent, ::Hash]
             #     Required. User event to write.
+            #   @param write_async [::Boolean]
+            #     If set to true, the user event is written asynchronously after
+            #     validation, and the API responds without waiting for the write.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::UserEvent]
@@ -257,10 +271,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.write_user_event.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -359,10 +374,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.collect_user_event.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -390,7 +406,7 @@ module Google
             end
             ##
-            # Bulk import of User events. Request processing might be
+            # Bulk import of user events. Request processing might be
             # synchronous. Events that already exist are skipped.
             # Use this method for backfilling historical user events.
             #
@@ -467,10 +483,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.import_user_events.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}

data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb CHANGED Viewed

@@ -26,6 +26,9 @@ module Google
         module UserEventService
           # Service that implements Longrunning Operations API.
           class Operations
+            # @private
+            API_VERSION = ""
             # @private
             DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
@@ -191,10 +194,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.list_operations.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -287,10 +291,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.get_operation.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -376,10 +381,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.delete_operation.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -470,10 +476,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.cancel_operation.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               header_params = {}
@@ -574,10 +581,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.wait_operation.metadata.to_h
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,

data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb CHANGED Viewed

@@ -122,6 +122,27 @@ module Google
               resource.call(**args)
             end
+            ##
+            # Create a fully-qualified Engine resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param collection [String]
+            # @param engine [String]
+            #
+            # @return [::String]
+            def engine_path project:, location:, collection:, engine:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+              "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}"
+            end
             extend self
           end
         end

data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb CHANGED Viewed

@@ -33,6 +33,9 @@ module Google
             # Service for ingesting end user actions on a website to Discovery Engine API.
             #
             class Client
+              # @private
+              API_VERSION = ""
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
@@ -205,16 +208,27 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload write_user_event(parent: nil, user_event: nil)
+              # @overload write_user_event(parent: nil, user_event: nil, write_async: nil)
               #   Pass arguments to `write_user_event` 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 parent [::String]
-              #     Required. The parent DataStore resource name, such as
+              #     Required. The parent resource name.
+              #     If the write user event action is applied in
+              #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} level, the format
+              #     is:
               #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+              #     If the write user event action is applied in [Location][] level, for
+              #     example, the event with
+              #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
+              #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, the format is:
+              #     `projects/{project}/locations/{location}`.
               #   @param user_event [::Google::Cloud::DiscoveryEngine::V1::UserEvent, ::Hash]
               #     Required. User event to write.
+              #   @param write_async [::Boolean]
+              #     If set to true, the user event is written asynchronously after
+              #     validation, and the API responds without waiting for the write.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::UserEvent]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -249,12 +263,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.write_user_event.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.write_user_event.timeout,
@@ -344,12 +359,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.collect_user_event.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.collect_user_event.timeout,
@@ -369,7 +385,7 @@ module Google
               end
               ##
-              # Bulk import of User events. Request processing might be
+              # Bulk import of user events. Request processing might be
               # synchronous. Events that already exist are skipped.
               # Use this method for backfilling historical user events.
               #
@@ -445,12 +461,13 @@ module Google
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.import_user_events.metadata.to_h
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_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::DiscoveryEngine::V1::VERSION,
                   transports_version_send: [:rest]
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
                 options.apply_defaults timeout:      @config.rpcs.import_user_events.timeout,