google-cloud-discovery_engine-v1beta 0.12.0 → 0.14.0

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

@@ -339,6 +339,41 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # AlloyDB source import data from.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the AlloyDB source is in
+        #     with a length limit of 128 characters. If not specified, inherits the
+        #     project ID from the parent request.
+        # @!attribute [rw] location_id
+        #   @return [::String]
+        #     Required. The AlloyDB location to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] cluster_id
+        #   @return [::String]
+        #     Required. The AlloyDB cluster to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     Required. The AlloyDB database to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The AlloyDB table to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     AlloyDB export to a specific Cloud Storage directory.
+        #
+        #     Ensure that the AlloyDB service account has the necessary Cloud
+        #     Storage Admin permissions to access the specified Cloud Storage directory.
+        class AlloyDbSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Firestore source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
@@ -497,6 +532,9 @@ module Google
         # @!attribute [rw] firestore_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource]
         #     Firestore input source.
+        # @!attribute [rw] alloy_db_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource]
+        #     AlloyDB input source.
         # @!attribute [rw] bigtable_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource]
         #     Cloud Bigtable input source.
@@ -690,6 +728,167 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#import_completion_suggestions CompletionService.ImportCompletionSuggestions}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportCompletionSuggestionsRequest::InlineSource]
+        #     The Inline source for suggestion entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
+        #     Cloud Storage location for the input content.
+        # @!attribute [rw] bigquery_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource]
+        #     BigQuery input source.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import customer
+        #     autocomplete suggestions.
+        #
+        #     Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportCompletionSuggestionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for CompletionSuggestions.
+          # @!attribute [rw] suggestions
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion>]
+          #     Required. A list of all denylist entries to import. Max of 1000 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#import_completion_suggestions CompletionService.ImportCompletionSuggestions}
+        # method. If the long running operation is done, this message is returned by
+        # the google.longrunning.Operations.response field if the operation is
+        # successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportCompletionSuggestionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportCompletionSuggestions
+        # 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.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion CompletionSuggestion}s
+        #     successfully imported.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion CompletionSuggestion}s
+        #     that failed to be imported.
+        class ImportCompletionSuggestionsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#import_sample_queries SampleQueryService.ImportSampleQueries}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportSampleQueriesRequest::InlineSource]
+        #     The Inline source for sample query entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
+        #     Cloud Storage location for the input content.
+        # @!attribute [rw] bigquery_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource]
+        #     BigQuery input source.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent sample query set resource name, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s under this
+        #     sample query set, regardless of whether or not this sample query set
+        #     exists, a `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportSampleQueriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s.
+          # @!attribute [rw] sample_queries
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery>]
+          #     Required. A list of
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s to
+          #     import. Max of 1000 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#import_sample_queries SampleQueryService.ImportSampleQueries}
+        # method. If the long running operation is done, this message is returned by
+        # the google.longrunning.Operations.response field if the operation is
+        # successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportSampleQueriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportSampleQueries
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     ImportSampleQueries operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     ImportSampleQueries operation last update time. If the operation is done,
+        #     this is also the finish time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s
+        #     successfully imported.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s
+        #     that failed to be imported.
+        # @!attribute [rw] total_count
+        #   @return [::Integer]
+        #     Total count of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s that were
+        #     processed.
+        class ImportSampleQueriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -21,6 +21,83 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1beta
+        # Request message for PurgeUserEvents method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the catalog under which the events are
+        #     created. The format is
+        #     `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Required. The filter string to specify the events to be deleted with a
+        #     length limit of 5,000 characters. The eligible fields for filtering are:
+        #
+        #     * `eventType`: Double quoted
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#event_type UserEvent.event_type}
+        #     string.
+        #     * `eventTime`: in ISO 8601 "zulu" format.
+        #     * `userPseudoId`: Double quoted string. Specifying this will delete all
+        #       events associated with a visitor.
+        #     * `userId`: Double quoted string. Specifying this will delete all events
+        #       associated with a user.
+        #
+        #     Examples:
+        #
+        #     * Deleting all events in a time range:
+        #       `eventTime > "2012-04-23T18:25:43.511Z"
+        #       eventTime < "2012-04-23T18:30:43.511Z"`
+        #     * Deleting specific eventType:
+        #       `eventType = "search"`
+        #     * Deleting all events for a specific visitor:
+        #       `userPseudoId = "visitor1024"`
+        #     * Deleting all events inside a DataStore:
+        #       `*`
+        #
+        #     The filtering fields are assumed to have an implicit AND.
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     The `force` field is currently not supported. Purge user event requests
+        #     will permanently delete all purgeable events. Once the development is
+        #     complete:
+        #     If `force` is set to false, the method will return the expected
+        #     purge count without deleting any user events. This field will default to
+        #     false if not included in the request.
+        class PurgeUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the PurgeUserEventsRequest. If the long running operation is
+        # successfully done, then this message is returned by the
+        # google.longrunning.Operations.response field.
+        # @!attribute [rw] purge_count
+        #   @return [::Integer]
+        #     The total count of events purged as a result of the operation.
+        class PurgeUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeUserEvents 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.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of entries that were deleted successfully.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of entries that encountered errors while processing.
+        class PurgeUserEventsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
         # method.
@@ -122,6 +199,48 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to purge completion
+        #     suggestions. Follows pattern
+        #     projects/*/locations/*/collections/*/dataStores/*.
+        class PurgeCompletionSuggestionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] purge_succeeded
+        #   @return [::Boolean]
+        #     Whether the completion suggestions were successfully purged.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class PurgeCompletionSuggestionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeCompletionSuggestions
+        # operation. This is 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 PurgeCompletionSuggestionsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 Cloud
+    module DiscoveryEngine
+      module V1beta
+        # Sample Query captures metadata to be used for evaluation.
+        # @!attribute [rw] query_entry
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry]
+        #     The query entry.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The full resource name of the sample query, in the format of
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} was created
+        #     at.
+        class SampleQuery
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Query Entry captures metadata to be used for search evaluation.
+          # @!attribute [rw] query
+          #   @return [::String]
+          #     Required. The query.
+          # @!attribute [rw] targets
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>]
+          #     List of targets for the query.
+          class QueryEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Defines the parameters of the query's expected outcome.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     Expected uri of the target.
+            #
+            #     This field must be a UTF-8 encoded string with a length limit of 2048
+            #     characters.
+            #
+            #     Example of valid uris: `https://example.com/abc`,
+            #     `gcs://example/example.pdf`.
+            # @!attribute [rw] page_numbers
+            #   @return [::Array<::Integer>]
+            #     Expected page numbers of the target.
+            #
+            #     Each page number must be non negative.
+            # @!attribute [rw] score
+            #   @return [::Float]
+            #     Relevance score of the target.
+            class Target
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 Cloud
+    module DiscoveryEngine
+      module V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#get_sample_query SampleQueryService.GetSampleQuery}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
+        #     of whether or not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the requested
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} does not
+        #     exist, a NOT_FOUND error is returned.
+        class GetSampleQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent sample query set resource name, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s under this
+        #     sample query set, regardless of whether or not this sample query set
+        #     exists, a `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s to return.
+        #     If unspecified, defaults to 100. The maximum allowed value is 1000. Values
+        #     above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesResponse#next_page_token ListSampleQueriesResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
+        #     must match the call that provided the page token. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class ListSampleQueriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
+        # method.
+        # @!attribute [rw] sample_queries
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery>]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesRequest#page_token ListSampleQueriesRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListSampleQueriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#create_sample_query SampleQueryService.CreateSampleQuery}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        # @!attribute [rw] sample_query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
+        #     Required. The
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to create.
+        # @!attribute [rw] sample_query_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, which will
+        #     become the final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery#name SampleQuery.name}.
+        #
+        #     If the caller does not have permission to create the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
+        #     of whether or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     This field must be unique among all
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s with the
+        #     same
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQueryRequest#parent parent}.
+        #     Otherwise, an `ALREADY_EXISTS` error is returned.
+        #
+        #     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class CreateSampleQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#update_sample_query SampleQueryService.UpdateSampleQuery}
+        # method.
+        # @!attribute [rw] sample_query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
+        #     Required. The simple query to update.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
+        #     of whether or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
+        #     update does not exist a `NOT_FOUND` error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided imported 'simple query' to update.
+        #     If not set, will by default update all fields.
+        class UpdateSampleQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#delete_sample_query SampleQueryService.DeleteSampleQuery}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
+        #
+        #     If the caller does not have permission to delete the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
+        #     of whether or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
+        #     delete does not exist, a `NOT_FOUND` error is returned.
+        class DeleteSampleQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 Cloud
+    module DiscoveryEngine
+      module V1beta
+        # A SampleQuerySet is the parent resource of SampleQuery, and contains the
+        # configurations shared by all SampleQuery under it.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The full resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, in
+        #     the format of
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The sample query set display name.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 128
+        #     characters.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} was
+        #     created at.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
+        class SampleQuerySet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end