Package com.google.cloud.recommendationengine.v1beta1

Interface PurgeUserEventsRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Required.
      com.google.protobuf.ByteString getFilterBytes()
      Required.
      boolean getForce()
      Optional.
      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 Detail

      • getParent

        String getParent()
         Required. The resource name of the event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
        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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
        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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: Deleting all events for a specific visitor
 `visitorId = visitor1024`
 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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: Deleting all events for a specific visitor
 `visitorId = visitor1024`
 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()
         Optional. The default value is false. Override this flag to true to
 actually perform the purge. If the field is not set to true, a sampling of
 events to be deleted will be returned.
        bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The force.