public static final class PurgeUserEventsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder
Request message for PurgeUserEvents method.Protobuf type
google.cloud.retail.v2alpha.PurgeUserEventsRequest| Modifier and Type | Method and Description |
|---|---|
PurgeUserEventsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeUserEventsRequest |
build() |
PurgeUserEventsRequest |
buildPartial() |
PurgeUserEventsRequest.Builder |
clear() |
PurgeUserEventsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PurgeUserEventsRequest.Builder |
clearFilter()
Required.
|
PurgeUserEventsRequest.Builder |
clearForce()
Actually perform the purge.
|
PurgeUserEventsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PurgeUserEventsRequest.Builder |
clearParent()
Required.
|
PurgeUserEventsRequest.Builder |
clone() |
PurgeUserEventsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
Required.
|
com.google.protobuf.ByteString |
getFilterBytes()
Required.
|
boolean |
getForce()
Actually perform the purge.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PurgeUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PurgeUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PurgeUserEventsRequest.Builder |
mergeFrom(PurgeUserEventsRequest other) |
PurgeUserEventsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PurgeUserEventsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeUserEventsRequest.Builder |
setFilter(String value)
Required.
|
PurgeUserEventsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeUserEventsRequest.Builder |
setForce(boolean value)
Actually perform the purge.
|
PurgeUserEventsRequest.Builder |
setParent(String value)
Required.
|
PurgeUserEventsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeUserEventsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PurgeUserEventsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PurgeUserEventsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PurgeUserEventsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PurgeUserEventsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface PurgeUserEventsRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getParentBytes in interface PurgeUserEventsRequestOrBuilderpublic 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) = { ... }
value - The parent to set.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) = { ... }
public PurgeUserEventsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
value - The bytes for parent to set.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][google.cloud.retail.v2alpha.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];getFilter in interface PurgeUserEventsRequestOrBuilderpublic com.google.protobuf.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][google.cloud.retail.v2alpha.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];getFilterBytes in interface PurgeUserEventsRequestOrBuilderpublic 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][google.cloud.retail.v2alpha.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];value - The filter to set.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][google.cloud.retail.v2alpha.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];public PurgeUserEventsRequest.Builder setFilterBytes(com.google.protobuf.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][google.cloud.retail.v2alpha.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];value - The bytes for filter to set.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;getForce in interface PurgeUserEventsRequestOrBuilderpublic 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;value - The force to set.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;public final PurgeUserEventsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>public final PurgeUserEventsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.