google-apis-discoveryengine_v1alpha 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec8f8082c4de03bd947d1459c082a886341d7488b998a2e560d26f635825b3e5
-  data.tar.gz: eaa59bc81d66de1a4adec80a727289bc1df3a1f443d62cc02377da136f8bf209
+  metadata.gz: 76cc0be63dc858237fa1cccf673e2c6f9676414b45a3ffedac5d2cd0ab7be73a
+  data.tar.gz: 8ff052786a416019d29fac0385b113fe52353d3a955181493cb2c1fc2caebf06
 SHA512:
-  metadata.gz: 85a336a82551c5e970170ae86df7992da40e655267244bde1371e9388150dc62fa7000b44d3b1d2019e30faed99e3a6451cde0f3873e9be685379488b4e56408
-  data.tar.gz: 8696b24aada09bc7a4f430bc9f9d50083d007801e93b8fd0a512b9d360becbabb7bdb287eac2ccfa6130d866643bacb4d6fc86188be9ff3cd13980eabd03a781
+  metadata.gz: b56c418a1ba9dfbdb6cae5fbc7c30d6cafe859cabd910cdbf2e25283d070793712f6a72c9292ce2e3c5b165442cc643ec849769525b6bc5c906b367bbe539e12
+  data.tar.gz: 50d7c1f59779898b6781a860fad61965fbaa8ca745046df4ed5fb46575fe27f2c4801d125c964be39cbd8d79a2c20d35590feb570760bd15c666c55f72e80fd9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.13.0 (2023-06-25)
+
+* Regenerated from discovery document revision 20230620
+
 ### v0.12.0 (2023-05-28)
 
 * Regenerated from discovery document revision 20230525

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

@@ -754,14 +754,14 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaDocumentInfo
         include Google::Apis::Core::Hashable
       
-        # Required. The Document resource ID.
+        # The Document resource ID.
         # Corresponds to the JSON property `id`
         # @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``
+        # 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
@@ -780,7 +780,7 @@ module Google
         # @return [Fixnum]
         attr_accessor :quantity
       
-        # Required. The Document url - only allowed for DataStores with content_config
+        # The Document url - only allowed for DataStores with content_config
         # PUBLIC_WEBSITE.
         # Corresponds to the JSON property `uri`
         # @return [String]
@@ -811,8 +811,10 @@ module Google
         # ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`
         # : One custom data JSON per row in arbitrary format that conforms the defined
         # Schema of the data store. This can only be used by the GENERIC Data Store
-        # vertical. Supported values for user even imports: * `user_event` (default):
-        # One JSON UserEvent per line.
+        # vertical. * `csv`: A CSV file with header conforming the defined Schema of the
+        # data store. Each entry after the header will be imported as a Document. This
+        # can only be used by the GENERIC Data Store vertical. Supported values for user
+        # even imports: * `user_event` (default): One JSON UserEvent per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
@@ -888,8 +890,8 @@ module Google
         # If unset or set to `false`, Document.ids have to be specified using id_field,
         # otherwises, documents without IDs will fail to be imported. Only set this
         # field when using GcsSource or BigQuerySource, and when GcsSource.data_schema
-        # or BigQuerySource.data_schema is `custom`. Otherwise, an INVALID_ARGUMENT
-        # error is thrown.
+        # or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an
+        # INVALID_ARGUMENT error is thrown.
         # Corresponds to the JSON property `autoGenerateIds`
         # @return [Boolean]
         attr_accessor :auto_generate_ids
@@ -1403,6 +1405,106 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeUserEvents operation. This will
+      # be returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
+        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 PurgeUserEvents method.
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest
+        include Google::Apis::Core::Hashable
+      
+        # 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 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.
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # 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.
+        # 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 of the PurgeUserEventsRequest. If the long running operation is
+      # successfully done, then this message is returned by the google.longrunning.
+      # Operations.response field.
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of events purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+        end
+      end
+      
       # Request message for Recommend method.
       class GoogleCloudDiscoveryengineV1alphaRecommendRequest
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha 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 = "20230525"
+      REVISION = "20230620"
     end
   end
 end

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

@@ -250,6 +250,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaRecommendRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -753,6 +771,31 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
+        # @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 GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :force, as: 'force'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaRecommendRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -731,6 +731,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Deletes permanently all user events specified by the filter provided.
+        # Depending on the number of events specified by the filter, this operation
+        # could take hours or days to complete. To test a filter, use the list command
+        # first.
+        # @param [String] parent
+        #   Required. The resource name of the catalog under which the events are created.
+        #   The format is `projects/$`projectId`/locations/global/collections/`$
+        #   collectionId`/dataStores/$`dataStoreId``
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_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::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::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_user_event(parent, google_cloud_discoveryengine_v1alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::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
+        
         # Writes a single user event.
         # @param [String] parent
         #   Required. The parent DataStore resource name, such as `projects/`project`/
@@ -1518,6 +1556,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Deletes permanently all user events specified by the filter provided.
+        # Depending on the number of events specified by the filter, this operation
+        # could take hours or days to complete. To test a filter, use the list command
+        # first.
+        # @param [String] parent
+        #   Required. The resource name of the catalog under which the events are created.
+        #   The format is `projects/$`projectId`/locations/global/collections/`$
+        #   collectionId`/dataStores/$`dataStoreId``
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_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::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::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_user_event(parent, google_cloud_discoveryengine_v1alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::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
+        
         # Writes a single user event.
         # @param [String] parent
         #   Required. The parent DataStore resource name, such as `projects/`project`/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 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-05-28 00:00:00.000000000 Z
+date: 2023-06-25 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_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.12.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.13.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []