google-apis-discoveryengine_v1beta 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7509dba55794eacd73c4e603805c00200c9bc37c9f8b86c5c07a28909cb5f8
-  data.tar.gz: dd1ba6ad1ffe64ec09851050f6c11d03ecb31d13912513db4cd790f7304beea6
+  metadata.gz: fd82e65a2718fe6cf2664b8baf510c457f310f541b0081abf0b5f1efacc88c05
+  data.tar.gz: 0f11a80e71d3d0e07dc8ff93540c281e9d79857301e29f3ed091c3e9e20ea9f0
 SHA512:
-  metadata.gz: 0747d5c6f5b5d85390490356088fa66088d5644561843c7b65fa8fe6eec283d1977177dbec5ebb9f6a3ca86403babc1977ad660d571cb722bdcd255c1d5ea142
-  data.tar.gz: 83835ba3f87763e0f43710af59b47ca40a7a7b431fa3cb3f5bdbc196001b74ebb6521cbf17e20843e4030e8da2fd1b7f83353ce21d1d86bfe3ad54d17dfb8628
+  metadata.gz: daf5b78901c7d9a4c9f62ce6d6b40e7185d0c04c89aadbc9fafcabb7fd9d59a976ce45cb9a65a6c8f228c6c264957eccbf704be06375c14ede267041c0108801
+  data.tar.gz: 228de354cd75fc3145de63358763e09470763453d2d6ddbd4f6ff15a0f19d9597cca024b01f19f307a8e1122e11f62badcde4fde285d10d52384712c1d39d2c7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1beta
 
+### v0.13.0 (2023-05-14)
+
+* Regenerated from discovery document revision 20230504
+
 ### v0.12.0 (2023-04-16)
 
 * Regenerated from discovery document revision 20230408

data/lib/google/apis/discoveryengine_v1beta/classes.rb

@@ -442,6 +442,74 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeDocuments operation. This will be
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Count of entries that encountered errors while processing.
+        # Corresponds to the JSON property `failureCount`
+        # @return [Fixnum]
+        attr_accessor :failure_count
+      
+        # Count of entries that were deleted successfully.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @failure_count = args[:failure_count] if args.key?(:failure_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Response message for DocumentService.PurgeDocuments method. If the long
+      # running operation is successfully done, then this message is returned by the
+      # google.longrunning.Operations.response field.
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of documents purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        # A sample of document names that will be deleted. Only populated if `force` is
+        # set to false. A max of 100 names will be returned and the names are chosen at
+        # random.
+        # Corresponds to the JSON property `purgeSample`
+        # @return [Array<String>]
+        attr_accessor :purge_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+          @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
+        end
+      end
+      
       # Defines the structure and layout of a type of document data.
       class GoogleCloudDiscoveryengineV1alphaSchema
         include Google::Apis::Core::Hashable
@@ -577,16 +645,18 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
-        # the key is "lengths_cm". Exactly one of text or numbers should be set.
-        # Otherwise, an INVALID_ARGUMENT error is returned.
+        # the key is "lengths_cm". Exactly one of CustomAttribute.text or
+        # CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error
+        # is returned.
         # Corresponds to the JSON property `numbers`
         # @return [Array<Float>]
         attr_accessor :numbers
       
         # The textual values of this custom attribute. For example, `["yellow", "green"]`
-        # when the key is "color". Empty string is not allowed. Otherwise, an
-        # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
-        # set. Otherwise, an INVALID_ARGUMENT error is returned.
+        # when the key is "color". Empty string is not allowed. Otherwise, an `
+        # INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or
+        # CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error
+        # is returned.
         # Corresponds to the JSON property `text`
         # @return [Array<String>]
         attr_accessor :text
@@ -615,7 +685,7 @@ module Google
         attr_accessor :id
       
         # The JSON string representation of the document. It should conform to the
-        # registered schema or an INVALID_ARGUMENT error is thrown.
+        # registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.
         # Corresponds to the JSON property `jsonData`
         # @return [String]
         attr_accessor :json_data
@@ -641,7 +711,7 @@ module Google
         attr_accessor :schema_id
       
         # The structured JSON data for the document. It should conform to the registered
-        # schema or an INVALID_ARGUMENT error is thrown.
+        # Schema.schema or an `INVALID_ARGUMENT` error is thrown.
         # Corresponds to the JSON property `structData`
         # @return [Hash<String,Object>]
         attr_accessor :struct_data
@@ -670,9 +740,9 @@ module Google
         # @return [String]
         attr_accessor :id
       
-        # Required. The 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`
+        # Required. The 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``
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -691,6 +761,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :quantity
       
+        # Required. The Document url - only allowed for DataStores with content_config
+        # PUBLIC_WEBSITE.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
         def initialize(**args)
            update!(**args)
         end
@@ -701,6 +777,7 @@ module Google
           @name = args[:name] if args.key?(:name)
           @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
           @quantity = args[:quantity] if args.key?(:quantity)
+          @uri = args[:uri] if args.key?(:uri)
         end
       end
       
@@ -1066,7 +1143,7 @@ module Google
         attr_accessor :media_progress_duration
       
         # Media progress should be computed using only the media_progress_duration
-        # relative to the media total length. This value must be between [0, 1.0]
+        # relative to the media total length. This value must be between `[0, 1.0]`
         # inclusive. If this is not a playback or the progress cannot be computed (e.g.
         # ongoing livestream), this field should be unset.
         # Corresponds to the JSON property `mediaProgressPercentage`
@@ -1178,19 +1255,115 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeDocuments operation. This will be
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Count of entries that encountered errors while processing.
+        # Corresponds to the JSON property `failureCount`
+        # @return [Fixnum]
+        attr_accessor :failure_count
+      
+        # Count of entries that were deleted successfully.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @failure_count = args[:failure_count] if args.key?(:failure_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Request message for DocumentService.PurgeDocuments method.
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Filter matching documents to purge. Only currently supported value
+        # is `*` (all items).
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # Actually performs the purge. If `force` is set to false, return the expected
+        # purge count without deleting any documents.
+        # Corresponds to the JSON property `force`
+        # @return [Boolean]
+        attr_accessor :force
+        alias_method :force?, :force
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @force = args[:force] if args.key?(:force)
+        end
+      end
+      
+      # Response message for DocumentService.PurgeDocuments method. If the long
+      # running operation is successfully done, then this message is returned by the
+      # google.longrunning.Operations.response field.
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of documents purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        # A sample of document names that will be deleted. Only populated if `force` is
+        # set to false. A max of 100 names will be returned and the names are chosen at
+        # random.
+        # Corresponds to the JSON property `purgeSample`
+        # @return [Array<String>]
+        attr_accessor :purge_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+          @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
+        end
+      end
+      
       # Request message for Recommend method.
       class GoogleCloudDiscoveryengineV1betaRecommendRequest
         include Google::Apis::Core::Hashable
       
         # Filter for restricting recommendation results with a length limit of 5,000
         # characters. Currently, only filter expressions on the `filter_tags` attribute
-        # is supported. Examples: * (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY(
-        # "Hot", "Cold")) * (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("
-        # Green")) If your filter blocks all results, the API will return generic (
-        # unfiltered) popular Documents. If you only want results strictly matching the
+        # is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags:
+        # ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
+        # ANY("Green"))` If your filter blocks all results, the API will return generic
+        # (unfiltered) popular Documents. If you only want results strictly matching the
         # filters, set `strictFiltering` to True in RecommendRequest.params to receive
-        # empty results instead. Note that the API will never return Documents with
-        # storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
+        # empty results instead. Note that the API will never return Documents with `
+        # storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -1205,17 +1378,17 @@ module Google
       
         # Additional domain specific parameters for the recommendations. Allowed values:
         # * `returnDocument`: Boolean. If set to true, the associated Document object
-        # will be returned in RecommendResponse.results.document. * `returnScore`:
-        # Boolean. If set to true, the recommendation 'score' corresponding to each
-        # returned Document will be set in RecommendResponse.results.metadata. The given
-        # 'score' indicates the probability of a Document conversion given the user's
-        # context and history. * `strictFiltering`: Boolean. True by default. If set to
-        # false, the service will return generic (unfiltered) popular Documents instead
-        # of empty if your filter blocks all recommendation results. * `diversityLevel`:
-        # String. Default empty. If set to be non-empty, then it needs to be one of: * '
-        # no-diversity' * 'low-diversity' * 'medium-diversity' * 'high-diversity' * '
-        # auto-diversity' This gives request-level control and adjusts recommendation
-        # results based on Document category.
+        # will be returned in RecommendResponse.RecommendationResult.document. * `
+        # returnScore`: Boolean. If set to true, the recommendation 'score'
+        # corresponding to each returned Document will be set in RecommendResponse.
+        # RecommendationResult.metadata. The given 'score' indicates the probability of
+        # a Document conversion given the user's context and history. * `strictFiltering`
+        # : Boolean. True by default. If set to false, the service will return generic (
+        # unfiltered) popular Documents instead of empty if your filter blocks all
+        # recommendation results. * `diversityLevel`: String. Default empty. If set to
+        # be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
+        # `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
+        # level control and adjusts recommendation results based on Document category.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -1402,8 +1575,8 @@ module Google
         # The user's search query. See SearchRequest.query for definition. The value
         # must be a UTF-8 encoded string with a length limit of 5,000 characters.
         # Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query
-        # or page_categories is required for `search` events. Other event types should
-        # not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        # or PageInfo.page_category is required for `search` events. Other event types
+        # should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `searchQuery`
         # @return [String]
         attr_accessor :search_query
@@ -1492,33 +1665,33 @@ module Google
         # imported events and events provided with prediction requests. This lets the
         # Discovery Engine API use those custom attributes when training models and
         # serving predictions, which helps improve recommendation quality. This field
-        # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
+        # needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is
         # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
         # 000 characters. * For text attributes, at most 400 values are allowed. Empty
         # values are not allowed. Each value must be a UTF-8 encoded string with a
         # length limit of 256 characters. * For number attributes, at most 400 values
         # are allowed. For product recommendations, an example of extra user information
-        # is traffic_channel, which is how a user arrives at the site. Users can arrive
-        # at the site by coming to the site directly, coming through Google search, or
-        # in other ways.
+        # is ` traffic_channel`, which is how a user arrives at the site. Users can
+        # arrive at the site by coming to the site directly, coming through Google
+        # search, or in other ways.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomAttribute>]
         attr_accessor :attributes
       
         # Token to attribute an API response to user action(s) to trigger the event.
-        # Highly recommended for user events that are the result of PredictionService.
-        # Predict. This field enables accurate attribution of recommendation model
-        # performance. The value must be one of: * PredictResponse.attribution_token for
-        # events that are the result of PredictionService.Predict. * SearchResponse.
-        # attribution_token for events that are the result of SearchService.Search. *
-        # CompleteQueryResponse.attribution_token for events that are the result of
-        # SearchService.CompleteQuery. This token enables us to accurately attribute
-        # page view or conversion completion back to the event and the particular
-        # predict response containing this clicked/purchased product. If user clicks on
-        # product K in the recommendation results, pass PredictResponse.
-        # attribution_token as a URL parameter to product K's page. When recording
-        # events on product K's page, log the PredictResponse.attribution_token to this
-        # field.
+        # Highly recommended for user events that are the result of
+        # RecommendationService.Recommend. This field enables accurate attribution of
+        # recommendation model performance. The value must be one of: * PredictResponse.
+        # attribution_token for events that are the result of RecommendationService.
+        # Recommend. * SearchResponse.attribution_token for events that are the result
+        # of SearchService.Search. * CompleteQueryResponse.attribution_token for events
+        # that are the result of CompletionService.CompleteQuery. This token enables us
+        # to accurately attribute page view or conversion completion back to the event
+        # and the particular predict response containing this clicked/purchased product.
+        # If user clicks on product K in the recommendation results, pass
+        # PredictResponse.attribution_token as a URL parameter to product K's page. When
+        # recording events on product K's page, log the PredictResponse.
+        # attribution_token to this field.
         # Corresponds to the JSON property `attributionToken`
         # @return [String]
         attr_accessor :attribution_token
@@ -1571,11 +1744,11 @@ module Google
       
         # The filter syntax consists of an expression language for constructing a
         # predicate from one or more fields of the documents being filtered. One example
-        # is for `search` events, the associated SearchService.SearchRequest may contain
-        # a filter expression in SearchService.SearchRequest.filter conforming to https:/
-        # /google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are
-        # generated from a PredictionService.PredictRequest, this field may be populated
-        # directly from PredictionService.PredictRequest.filter conforming to https://
+        # is for `search` events, the associated SearchRequest may contain a filter
+        # expression in SearchRequest.filter conforming to https://google.aip.dev/160#
+        # filtering. Similarly, for `view-item-list` events that are generated from a
+        # RecommendationService.RecommendRequest, this field may be populated directly
+        # from RecommendationService.RecommendRequest.filter conforming to https://
         # google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a
         # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
         # returned.
@@ -1683,10 +1856,10 @@ module Google
       
         # User agent as included in the HTTP header. Required for getting SearchResponse.
         # sponsored_results. The field must be a UTF-8 encoded string with a length
-        # limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # This should not be set when using the client side event reporting with GTM or
-        # JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request
-        # is set.
+        # JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.
+        # direct_user_request is set.
         # Corresponds to the JSON property `userAgent`
         # @return [String]
         attr_accessor :user_agent
@@ -1696,7 +1869,7 @@ module Google
         # for this ID. Don't set the field to the same fixed ID for different users.
         # This mixes the event history of those users together, which results in
         # degraded model quality. The field must be a UTF-8 encoded string with a length
-        # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # Corresponds to the JSON property `userId`
         # @return [String]
         attr_accessor :user_id

data/lib/google/apis/discoveryengine_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1beta
       # Version of the google-apis-discoveryengine_v1beta gem
-      GEM_VERSION = "0.12.0"
+      GEM_VERSION = "0.13.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230408"
+      REVISION = "20230504"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1beta/representations.rb

@@ -94,6 +94,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSchema
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -214,6 +226,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1betaRecommendRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -409,6 +439,24 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :failure_count, :numeric_string => true, as: 'failureCount'
+          property :success_count, :numeric_string => true, as: 'successCount'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+          collection :purge_sample, as: 'purgeSample'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSchema
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -466,6 +514,7 @@ module Google
           property :name, as: 'name'
           collection :promotion_ids, as: 'promotionIds'
           property :quantity, as: 'quantity'
+          property :uri, as: 'uri'
         end
       end
       
@@ -608,6 +657,32 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :failure_count, :numeric_string => true, as: 'failureCount'
+          property :success_count, :numeric_string => true, as: 'successCount'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :force, as: 'force'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+          collection :purge_sample, as: 'purgeSample'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1betaRecommendRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/discoveryengine_v1beta/service.rb

@@ -57,12 +57,12 @@ module Google
         # @param [String] document_id
         #   Required. The ID to use for the Document, which will become the final
         #   component of the Document.name. If the caller does not have permission to
-        #   create the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. This field must be unique among all
-        #   Documents with the same 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.
+        #   create the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. This field must be unique among all
+        #   Documents with the same 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.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -98,9 +98,9 @@ module Google
         #   Required. Full resource name of Document, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch`/documents/`document``. If the caller does not have permission to
-        #   delete the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. If the Document to delete does not exist,
-        #   a NOT_FOUND error is returned.
+        #   delete the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
+        #   a `NOT_FOUND` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -133,9 +133,9 @@ module Google
         #   Required. Full resource name of Document, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch`/documents/`document``. If the caller does not have permission to
-        #   access the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. If the requested Document does not exist,
-        #   a NOT_FOUND error is returned.
+        #   access the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the requested Document does not exist,
+        #   a `NOT_FOUND` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -206,18 +206,18 @@ module Google
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch``. Use `default_branch` as the branch ID, to list documents under the
         #   default branch. If the caller does not have permission to list Documentss
-        #   under this branch, regardless of whether or not this branch exists, a
-        #   PERMISSION_DENIED error is returned.
+        #   under this branch, regardless of whether or not this branch exists, a `
+        #   PERMISSION_DENIED` error is returned.
         # @param [Fixnum] page_size
         #   Maximum number of Documents 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.
+        #   this field is negative, an `INVALID_ARGUMENT` error is returned.
         # @param [String] page_token
         #   A page token ListDocumentsResponse.next_page_token, received from a previous
         #   DocumentService.ListDocuments call. Provide this to retrieve the subsequent
         #   page. When paginating, all other parameters provided to DocumentService.
-        #   ListDocuments must match the call that provided the page token. Otherwise, an
-        #   INVALID_ARGUMENT error is returned.
+        #   ListDocuments must match the call that provided the page token. Otherwise, an `
+        #   INVALID_ARGUMENT` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -286,6 +286,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Permanently deletes all selected Documents in a branch. This process is
+        # asynchronous. Depending on the number of Documents to be deleted, this
+        # operation can take hours to complete. Before the delete operation completes,
+        # some Documents might still be returned by DocumentService.GetDocument or
+        # DocumentService.ListDocuments. To get a list of the Documents to be deleted,
+        # set PurgeDocumentsRequest.force to false.
+        # @param [String] parent
+        #   Required. The parent resource name, such as `projects/`project`/locations/`
+        #   location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
+        # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def purge_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
@@ -501,8 +540,8 @@ module Google
         
         # Makes a recommendation, which requires a contextual user event.
         # @param [String] serving_config
-        #   Required. Full resource name of the format: projects/*/locations/global/
-        #   collections/*/dataStores/*/servingConfigs/* Before you can request
+        #   Required. Full resource name of the format: `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
         #   recommendations from your model, you must create at least one serving config
         #   for it.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
@@ -655,6 +694,77 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the latest state of a long-running operation. Clients can use this method
+        # to poll the operation result at intervals as recommended by the API service.
+        # @param [String] name
+        #   The name of the operation resource.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/{+name}', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists operations that match the specified filter in the request. If the server
+        # doesn't support this method, it returns `UNIMPLEMENTED`.
+        # @param [String] name
+        #   The name of the operation's parent resource.
+        # @param [String] filter
+        #   The standard list filter.
+        # @param [Fixnum] page_size
+        #   The standard list page size.
+        # @param [String] page_token
+        #   The standard list page token.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
+          command.params['name'] = name unless name.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
@@ -734,12 +844,12 @@ module Google
         # @param [String] document_id
         #   Required. The ID to use for the Document, which will become the final
         #   component of the Document.name. If the caller does not have permission to
-        #   create the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. This field must be unique among all
-        #   Documents with the same 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.
+        #   create the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. This field must be unique among all
+        #   Documents with the same 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.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -775,9 +885,9 @@ module Google
         #   Required. Full resource name of Document, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch`/documents/`document``. If the caller does not have permission to
-        #   delete the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. If the Document to delete does not exist,
-        #   a NOT_FOUND error is returned.
+        #   delete the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
+        #   a `NOT_FOUND` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -810,9 +920,9 @@ module Google
         #   Required. Full resource name of Document, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch`/documents/`document``. If the caller does not have permission to
-        #   access the Document, regardless of whether or not it exists, a
-        #   PERMISSION_DENIED error is returned. If the requested Document does not exist,
-        #   a NOT_FOUND error is returned.
+        #   access the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the requested Document does not exist,
+        #   a `NOT_FOUND` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -883,18 +993,18 @@ module Google
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
         #   `branch``. Use `default_branch` as the branch ID, to list documents under the
         #   default branch. If the caller does not have permission to list Documentss
-        #   under this branch, regardless of whether or not this branch exists, a
-        #   PERMISSION_DENIED error is returned.
+        #   under this branch, regardless of whether or not this branch exists, a `
+        #   PERMISSION_DENIED` error is returned.
         # @param [Fixnum] page_size
         #   Maximum number of Documents 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.
+        #   this field is negative, an `INVALID_ARGUMENT` error is returned.
         # @param [String] page_token
         #   A page token ListDocumentsResponse.next_page_token, received from a previous
         #   DocumentService.ListDocuments call. Provide this to retrieve the subsequent
         #   page. When paginating, all other parameters provided to DocumentService.
-        #   ListDocuments must match the call that provided the page token. Otherwise, an
-        #   INVALID_ARGUMENT error is returned.
+        #   ListDocuments must match the call that provided the page token. Otherwise, an `
+        #   INVALID_ARGUMENT` error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -963,6 +1073,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Permanently deletes all selected Documents in a branch. This process is
+        # asynchronous. Depending on the number of Documents to be deleted, this
+        # operation can take hours to complete. Before the delete operation completes,
+        # some Documents might still be returned by DocumentService.GetDocument or
+        # DocumentService.ListDocuments. To get a list of the Documents to be deleted,
+        # set PurgeDocumentsRequest.force to false.
+        # @param [String] parent
+        #   Required. The parent resource name, such as `projects/`project`/locations/`
+        #   location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
+        # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
@@ -1178,8 +1327,8 @@ module Google
         
         # Makes a recommendation, which requires a contextual user event.
         # @param [String] serving_config
-        #   Required. Full resource name of the format: projects/*/locations/global/
-        #   collections/*/dataStores/*/servingConfigs/* Before you can request
+        #   Required. Full resource name of the format: `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
         #   recommendations from your model, you must create at least one serving config
         #   for it.
         # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.12.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.13.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
 post_install_message: 
 rdoc_options: []