Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest (v1.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest.

Request message for PurgeUserEvents method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.

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.

#force

def force() -> ::Boolean
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.

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#parent

def parent() -> ::String
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}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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}
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}