Class: Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

Overview

Request message for PurgeUserEvents method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.

Returns:

  • (::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 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.



65
66
67
68
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 65

class PurgeUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#force ⇒ ::Boolean

Returns 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.

Returns:

  • (::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.



65
66
67
68
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 65

class PurgeUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The resource name of the catalog under which the events are created. The format is projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Returns:

  • (::String) —

    Required. The resource name of the catalog under which the events are created. The format is projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.



65
66
67
68
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 65

class PurgeUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end