public static final class PurgeUserEventsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder
Request message for PurgeUserEvents method.Protobuf type
google.cloud.discoveryengine.v1.PurgeUserEventsRequest| Modifier and Type | Method and Description |
|---|---|
PurgeUserEventsRequest |
build() |
PurgeUserEventsRequest |
buildPartial() |
PurgeUserEventsRequest.Builder |
clear() |
PurgeUserEventsRequest.Builder |
clearFilter()
Required.
|
PurgeUserEventsRequest.Builder |
clearForce()
The `force` field is currently not supported.
|
PurgeUserEventsRequest.Builder |
clearParent()
Required.
|
PurgeUserEventsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PurgeUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PurgeUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PurgeUserEventsRequest.Builder |
mergeFrom(PurgeUserEventsRequest other) |
PurgeUserEventsRequest.Builder |
setFilter(String value)
Required.
|
PurgeUserEventsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeUserEventsRequest.Builder |
setForce(boolean value)
The `force` field is currently not supported.
|
PurgeUserEventsRequest.Builder |
setParent(String value)
Required.
|
PurgeUserEventsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PurgeUserEventsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PurgeUserEventsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface PurgeUserEventsRequestOrBuilderpublic 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) = { ... }
getParentBytes in interface PurgeUserEventsRequestOrBuilderpublic PurgeUserEventsRequest.Builder setParent(String value)
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) = { ... }
value - The parent to set.public PurgeUserEventsRequest.Builder clearParent()
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) = { ... }
public PurgeUserEventsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for parent to set.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][google.cloud.discoveryengine.v1.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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` * Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];getFilter in interface PurgeUserEventsRequestOrBuilderpublic 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.v1.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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` * Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];getFilterBytes in interface PurgeUserEventsRequestOrBuilderpublic PurgeUserEventsRequest.Builder setFilter(String value)
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.v1.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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` * Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];value - The filter to set.public PurgeUserEventsRequest.Builder clearFilter()
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.v1.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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` * Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];public PurgeUserEventsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
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.v1.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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` * Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];value - The bytes for filter to set.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;getForce in interface PurgeUserEventsRequestOrBuilderpublic PurgeUserEventsRequest.Builder setForce(boolean value)
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;value - The force to set.public PurgeUserEventsRequest.Builder clearForce()
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;Copyright © 2026 Google LLC. All rights reserved.