- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.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.33.0
- 0.32.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.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class PurgeUserEventsRequest.Builder extends GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilderRequest message for PurgeUserEvents method.
Protobuf type google.cloud.discoveryengine.v1alpha.PurgeUserEventsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeUserEventsRequest.BuilderImplements
PurgeUserEventsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public PurgeUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
clearFilter()
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 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.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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" Deleting all events inside a DataStore:
*The 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() 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;
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
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/collections/{$collectionId}/dataStores/${dataStoreId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
This builder for chaining. |
clone()
public PurgeUserEventsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
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 with a length limit of 5,000 characters. The eligible fields for filtering are:
eventType: Double quoted 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.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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" Deleting all events inside a DataStore:
*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 with a length limit of 5,000 characters. The eligible fields for filtering are:
eventType: Double quoted 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.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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" Deleting all events inside a DataStore:
*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() 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The force. |
getParent()
public String getParent() Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}
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 catalog under which the events are
created. The format is
projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}
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()| 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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| 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 with a length limit of 5,000 characters. The eligible fields for filtering are:
eventType: Double quoted 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.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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" Deleting all events inside a DataStore:
*The 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 with a length limit of 5,000 characters. The eligible fields for filtering are:
eventType: Double quoted 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.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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" Deleting all events inside a DataStore:
*The 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) 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;
| 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 catalog under which the events are
created. The format is
projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}
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 catalog under which the events are
created. The format is
projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}
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. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeUserEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PurgeUserEventsRequest.Builder |
|