public static final class PurgeUserEventsRequest.Builder extends GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder
Request message for PurgeUserEvents method.
Protobuf type google.cloud.retail.v2.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()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public PurgeUserEventsRequest build()
Returns
buildPartial()
public PurgeUserEventsRequest buildPartial()
Returns
clear()
public PurgeUserEventsRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearFilter()
public PurgeUserEventsRequest.Builder clearFilter()
Required. The filter string to specify the events to be deleted with a
length limit of 5,000 characters. Empty string filter is not allowed. The
eligible fields for filtering are:
eventType: Double quoted
UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.visitorId: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- 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()
Actually perform the purge.
If force is set to false, the method will return the expected purge count
without deleting any user events.
bool force = 3;
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearParent()
public PurgeUserEventsRequest.Builder clearParent()
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clone()
public PurgeUserEventsRequest.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public PurgeUserEventsRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getFilter()
public String getFilter()
Required. The filter string to specify the events to be deleted with a
length limit of 5,000 characters. Empty string filter is not allowed. The
eligible fields for filtering are:
eventType: Double quoted
UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.visitorId: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- 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];
| 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. Empty string filter is not allowed. The
eligible fields for filtering are:
eventType: Double quoted
UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.visitorId: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- 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];
getForce()
public boolean getForce()
Actually perform the purge.
If force is set to false, the method will return the expected purge count
without deleting any user events.
bool force = 3;
getParent()
public String getParent()
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| 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/${projectId}/locations/global/catalogs/${catalogId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(PurgeUserEventsRequest other)
public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)
Parameter
Returns
public PurgeUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PurgeUserEventsRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setFilter(String value)
public PurgeUserEventsRequest.Builder setFilter(String value)
Required. The filter string to specify the events to be deleted with a
length limit of 5,000 characters. Empty string filter is not allowed. The
eligible fields for filtering are:
eventType: Double quoted
UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.visitorId: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- 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];
| Name | Description |
| value | String
The filter to set.
|
Returns
setFilterBytes(ByteString value)
public PurgeUserEventsRequest.Builder setFilterBytes(ByteString value)
Required. The filter string to specify the events to be deleted with a
length limit of 5,000 characters. Empty string filter is not allowed. The
eligible fields for filtering are:
eventType: Double quoted
UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.visitorId: 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 in time range:
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
- 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];
| Name | Description |
| value | ByteString
The bytes for filter to set.
|
Returns
setForce(boolean value)
public PurgeUserEventsRequest.Builder setForce(boolean value)
Actually perform the purge.
If force is set to false, the method will return the expected purge count
without deleting any user events.
bool force = 3;
| Name | Description |
| value | boolean
The force to set.
|
Returns
setParent(String value)
public PurgeUserEventsRequest.Builder setParent(String value)
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | String
The parent to set.
|
Returns
setParentBytes(ByteString value)
public PurgeUserEventsRequest.Builder setParentBytes(ByteString value)
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | ByteString
The bytes for parent to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeUserEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
