Class PurgeUserEventsRequest.Builder (2.53.0) 

public static final class PurgeUserEventsRequest.Builder extends GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder

Request message for PurgeUserEvents method.

Protobuf type google.cloud.retail.v2alpha.PurgeUserEventsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeUserEventsRequest.Builder

Static 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
Overrides

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
Overrides

clearField(Descriptors.FieldDescriptor field)

public PurgeUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PurgeUserEventsRequest.Builder
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];

Returns
Type Description
PurgeUserEventsRequest.Builder

This builder for chaining.

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;

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
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) = { ... }

Returns
Type Description
PurgeUserEventsRequest.Builder

This builder for chaining.

clone()

public PurgeUserEventsRequest.Builder clone()
Returns
Type Description
PurgeUserEventsRequest.Builder
Overrides

getDefaultInstanceForType()

public PurgeUserEventsRequest getDefaultInstanceForType()
Returns
Type Description
PurgeUserEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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];

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. 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];

Returns
Type Description
ByteString

The bytes for filter.

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;

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/catalogs/${catalogId}

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/catalogs/${catalogId}

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PurgeUserEventsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PurgeUserEventsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurgeUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PurgeUserEventsRequest.Builder
Overrides

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
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];

Parameter
Name Description
value String

The 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. 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];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
PurgeUserEventsRequest.Builder

This builder for chaining.

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;

Parameter
Name Description
value boolean

The 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/catalogs/${catalogId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The 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/catalogs/${catalogId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The 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
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PurgeUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PurgeUserEventsRequest.Builder
Overrides