Package com.google.cloud.discoveryengine.v1beta

Interface PurgeUserEventsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PurgeUserEventsRequest, PurgeUserEventsRequest.Builder
@Generated public interface PurgeUserEventsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    boolean
    getForce()
    The `force` field is currently not supported.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       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][google.cloud.discoveryengine.v1beta.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.
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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][google.cloud.discoveryengine.v1beta.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.
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for filter.

    • getForce

      boolean getForce()
       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.
      bool force = 3;
      Returns:
      The force.