Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

Request message for PurgeUserEvents method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PurgeUserEventsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1PurgeUserEventsRequest.



6053
6054
6055
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6053

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filterString

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

Returns:

  • (String)


6041
6042
6043
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6041

def filter
  @filter
end

#forceBoolean Also known as: force?

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

Returns:

  • (Boolean)


6050
6051
6052
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6050

def force
  @force
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6058
6059
6060
6061
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6058

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @force = args[:force] if args.key?(:force)
end