google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb

@@ -258,6 +258,137 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngine SiteSearchEngine},
+        #     such as
+        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @!attribute [rw] sitemap
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Sitemap]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} to
+        #     create.
+        class CreateSitemapRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}, regardless of
+        #     whether or not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the requested {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}
+        #     does not exist, a NOT_FOUND error is returned.
+        class DeleteSitemapRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngine SiteSearchEngine},
+        #     such as
+        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @!attribute [rw] matcher
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsRequest::Matcher]
+        #     Optional. If specified, fetches the matching
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s. If not specified,
+        #     fetches all {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s in the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}.
+        class FetchSitemapsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s by
+          # their uris.
+          # @!attribute [rw] uris
+          #   @return [::Array<::String>]
+          #     The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} uris.
+          class UrisMatcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s.
+          # Currently only supports uris matcher.
+          # @!attribute [rw] uris_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsRequest::UrisMatcher]
+          #     Matcher by sitemap URIs.
+          class Matcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class CreateSitemapMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class DeleteSitemapMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
+        # method.
+        # @!attribute [rw] sitemaps_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsResponse::SitemapMetadata>]
+        #     List of {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s fetched.
+        class FetchSitemapsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains a {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} and its
+          # metadata.
+          # @!attribute [rw] sitemap
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Sitemap]
+          #     The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}.
+          class SitemapMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
         # method.
@@ -349,6 +480,11 @@ module Google
         #     an INVALID_ARGUMENT error is thrown. Each URI should match at least one
         #     {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite TargetSite} in
         #     `site_search_engine`.
+        # @!attribute [rw] site_credential
+        #   @return [::String]
+        #     Optional. Full resource name of the [SiteCredential][], such as
+        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
+        #     Only set to crawl private URIs.
         class RecrawlUrisRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -419,9 +555,19 @@ module Google
         #     finish time.
         # @!attribute [rw] invalid_uris
         #   @return [::Array<::String>]
+        #     Unique URIs in the request that have invalid format. Sample limited to
+        #     1000.
+        # @!attribute [rw] invalid_uris_count
+        #   @return [::Integer]
+        #     Total number of unique URIs in the request that have invalid format.
+        # @!attribute [rw] uris_not_matching_target_sites
+        #   @return [::Array<::String>]
         #     Unique URIs in the request that don't match any TargetSite in the
         #     DataStore, only match TargetSites that haven't been fully indexed, or match
-        #     a TargetSite with type EXCLUDE.
+        #     a TargetSite with type EXCLUDE. Sample limited to 1000.
+        # @!attribute [rw] uris_not_matching_target_sites_count
+        #   @return [::Integer]
+        #     Total number of URIs that don't match any TargetSites.
         # @!attribute [rw] valid_uris_count
         #   @return [::Integer]
         #     Total number of unique URIs in the request that are not in invalid_uris.

data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb

@@ -34,6 +34,7 @@ module Google
         #     * `view-item-list`: View of a panel or ordered list of Documents.
         #     * `view-home-page`: View of the home page.
         #     * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
+        #     * `add-feedback`: Add a user feedback.
         #
         #     Retail-related values:
         #
@@ -244,6 +245,10 @@ module Google
         # @!attribute [rw] media_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::MediaInfo]
         #     Media-specific info.
+        # @!attribute [rw] panels
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::PanelInfo>]
+        #     Optional. List of panels associated with this event.
+        #     Used for page-level impression data.
         class UserEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -430,7 +435,7 @@ module Google
         #   @return [::String]
         #     The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource
         #     full name, of the form:
-        #     `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
         # @!attribute [rw] uri
         #   @return [::String]
         #     The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} URI - only
@@ -478,6 +483,9 @@ module Google
         #     Must be set if
         #     {::Google::Cloud::DiscoveryEngine::V1beta::PanelInfo#panel_position panel_position}
         #     is set.
+        # @!attribute [rw] documents
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>]
+        #     Optional. The document IDs associated with this panel.
         class PanelInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/longrunning/operations.rb

@@ -42,7 +42,7 @@ module Google
     #     The error result of the operation in case of failure or cancellation.
     # @!attribute [rw] response
     #   @return [::Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
+    #     The normal, successful response of the operation.  If the original
     #     method returns no data on success, such as `Delete`, the response is
     #     `google.protobuf.Empty`.  If the original method is standard
     #     `Get`/`Create`/`Update`, the response should be the resource.  For other
@@ -55,7 +55,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.GetOperation.
+    # The request message for
+    # Operations.GetOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource.
@@ -64,7 +65,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.ListOperations.
+    # The request message for
+    # Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation's parent resource.
@@ -82,7 +84,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The response message for Operations.ListOperations.
+    # The response message for
+    # Operations.ListOperations.
     # @!attribute [rw] operations
     #   @return [::Array<::Google::Longrunning::Operation>]
     #     A list of operations that matches the specified filter in the request.
@@ -94,7 +97,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.CancelOperation.
+    # The request message for
+    # Operations.CancelOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be cancelled.
@@ -103,7 +107,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.DeleteOperation.
+    # The request message for
+    # Operations.DeleteOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be deleted.
@@ -112,7 +117,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.WaitOperation.
+    # The request message for
+    # Operations.WaitOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to wait on.
@@ -130,13 +136,12 @@ module Google
     #
     # Example:
     #
-    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
-    #       returns (google.longrunning.Operation) {
-    #     option (google.longrunning.operation_info) = {
-    #       response_type: "LongRunningRecognizeResponse"
-    #       metadata_type: "LongRunningRecognizeMetadata"
-    #     };
-    #   }
+    #     rpc Export(ExportRequest) returns (google.longrunning.Operation) {
+    #       option (google.longrunning.operation_info) = {
+    #         response_type: "ExportResponse"
+    #         metadata_type: "ExportMetadata"
+    #       };
+    #     }
     # @!attribute [rw] response_type
     #   @return [::String]
     #     Required. The message name of the primary return type for this

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -373,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Discovery Engine API.