Class PurgeUserEventsRequest

  • All Implemented Interfaces:
    PurgeUserEventsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class PurgeUserEventsRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements PurgeUserEventsRequestOrBuilder
     Request message for PurgeUserEvents method.
     
    Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface PurgeUserEventsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface PurgeUserEventsRequestOrBuilder
        Returns:
        The bytes for parent.
      • getFilter

        public 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];
        Specified by:
        getFilter in interface PurgeUserEventsRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public 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];
        Specified by:
        getFilterBytes in interface PurgeUserEventsRequestOrBuilder
        Returns:
        The bytes for filter.
      • getForce

        public 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];
        Specified by:
        getForce in interface PurgeUserEventsRequestOrBuilder
        Returns:
        The force.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static PurgeUserEventsRequest parseFrom​(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public PurgeUserEventsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public PurgeUserEventsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected PurgeUserEventsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<PurgeUserEventsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public PurgeUserEventsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder