Class PurgeUserEventsRequest (0.48.0) 

public final class PurgeUserEventsRequest extends GeneratedMessageV3 implements PurgeUserEventsRequestOrBuilder

Request message for PurgeUserEvents method.

Protobuf type google.cloud.discoveryengine.v1.PurgeUserEventsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PurgeUserEventsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurgeUserEventsRequest getDefaultInstance()
Returns
Type Description
PurgeUserEventsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PurgeUserEventsRequest.Builder newBuilder()
Returns
Type Description
PurgeUserEventsRequest.Builder

newBuilder(PurgeUserEventsRequest prototype)

public static PurgeUserEventsRequest.Builder newBuilder(PurgeUserEventsRequest prototype)
Parameter
Name Description
prototype PurgeUserEventsRequest
Returns
Type Description
PurgeUserEventsRequest.Builder

parseDelimitedFrom(InputStream input)

public static PurgeUserEventsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PurgeUserEventsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeUserEventsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeUserEventsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PurgeUserEventsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PurgeUserEventsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeUserEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeUserEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PurgeUserEventsRequest> parser()
Returns
Type Description
Parser<PurgeUserEventsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PurgeUserEventsRequest getDefaultInstanceForType()
Returns
Type Description
PurgeUserEventsRequest

getFilter()

public 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 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
Type Description
String

The filter.

getFilterBytes()

public 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 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
Type Description
ByteString

The bytes for filter.

getForce()

public 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
Type Description
boolean

The force.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<PurgeUserEventsRequest> getParserForType()
Returns
Type Description
Parser<PurgeUserEventsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PurgeUserEventsRequest.Builder newBuilderForType()
Returns
Type Description
PurgeUserEventsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeUserEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PurgeUserEventsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PurgeUserEventsRequest.Builder toBuilder()
Returns
Type Description
PurgeUserEventsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException