public final class PurgeUserEventsRequest extends GeneratedMessageV3 implements PurgeUserEventsRequestOrBuilder
Request message for PurgeUserEvents method.
Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PurgeUserEventsRequest.Builder newBuilder()
newBuilder(PurgeUserEventsRequest prototype)
public static PurgeUserEventsRequest.Builder newBuilder(PurgeUserEventsRequest prototype)
public static PurgeUserEventsRequest parseDelimitedFrom(InputStream input)
public static PurgeUserEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PurgeUserEventsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeUserEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PurgeUserEventsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeUserEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeUserEventsRequest parseFrom(CodedInputStream input)
public static PurgeUserEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PurgeUserEventsRequest parseFrom(InputStream input)
public static PurgeUserEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PurgeUserEventsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeUserEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PurgeUserEventsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public PurgeUserEventsRequest getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public 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 |
| Type |
Description |
ByteString |
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];
| Returns |
| Type |
Description |
boolean |
The force.
|
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) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<PurgeUserEventsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PurgeUserEventsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeUserEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PurgeUserEventsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
