public static final class PurgeUserEventsRequest.Builder extends GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder
Request message for PurgeUserEvents method.
Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PurgeUserEventsRequest build()
buildPartial()
public PurgeUserEventsRequest buildPartial()
clear()
public PurgeUserEventsRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearFilter()
public PurgeUserEventsRequest.Builder clearFilter()
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];
clearForce()
public PurgeUserEventsRequest.Builder clearForce()
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearParent()
public PurgeUserEventsRequest.Builder clearParent()
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) = { ... }
clone()
public PurgeUserEventsRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public PurgeUserEventsRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PurgeUserEventsRequest other)
public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)
public PurgeUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PurgeUserEventsRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setFilter(String value)
public PurgeUserEventsRequest.Builder setFilter(String value)
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];
| Parameter |
|---|
| Name | Description |
value | String
The filter to set.
|
setFilterBytes(ByteString value)
public PurgeUserEventsRequest.Builder setFilterBytes(ByteString value)
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];
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for filter to set.
|
setForce(boolean value)
public PurgeUserEventsRequest.Builder setForce(boolean value)
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];
| Parameter |
|---|
| Name | Description |
value | boolean
The force to set.
|
setParent(String value)
public PurgeUserEventsRequest.Builder setParent(String value)
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) = { ... }
| Parameter |
|---|
| Name | Description |
value | String
The parent to set.
|
setParentBytes(ByteString value)
public PurgeUserEventsRequest.Builder setParentBytes(ByteString value)
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) = { ... }
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for parent to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeUserEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
