- 0.92.0 (latest)
- 0.90.0
- 0.89.0
- 0.87.0
- 0.85.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.77.0
- 0.75.0
- 0.74.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.67.0
- 0.66.0
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.4
- 0.8.10
public static final class PurgeUserEventsRequest.Builder extends GeneratedMessage.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilderRequest message for PurgeUserEvents method.
Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PurgeUserEventsRequest.BuilderImplements
PurgeUserEventsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public PurgeUserEventsRequest build()| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest |
|
buildPartial()
public PurgeUserEventsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest |
|
clear()
public PurgeUserEventsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
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 visitorvisitorId = visitor1024The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public PurgeUserEventsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 visitorvisitorId = visitor1024The 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 visitorvisitorId = visitor1024The 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PurgeUserEventsRequest other)
public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
PurgeUserEventsRequest |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PurgeUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PurgeUserEventsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
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 visitorvisitorId = visitor1024The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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 visitorvisitorId = visitor1024The filtering fields are assumed to have an implicit AND.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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 |
booleanThe force to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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 |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |