Class PurgeUserEventsRequest.Builder (0.30.0)

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

Request message for PurgeUserEvents method.

Protobuf type google.cloud.discoveryengine.v1alpha.PurgeUserEventsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PurgeUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

build()

public PurgeUserEventsRequest build()
Returns
TypeDescription
PurgeUserEventsRequest

buildPartial()

public PurgeUserEventsRequest buildPartial()
Returns
TypeDescription
PurgeUserEventsRequest

clear()

public PurgeUserEventsRequest.Builder clear()
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PurgeUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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. 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
TypeDescription
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
TypeDescription
PurgeUserEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PurgeUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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/collections/{$collectionId}/dataStores/${dataStoreId}

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

Returns
TypeDescription
PurgeUserEventsRequest.Builder

This builder for chaining.

clone()

public PurgeUserEventsRequest.Builder clone()
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

getDefaultInstanceForType()

public PurgeUserEventsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeUserEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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. 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PurgeUserEventsRequest other)

public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)
Parameter
NameDescription
otherPurgeUserEventsRequest
Returns
TypeDescription
PurgeUserEventsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PurgeUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PurgeUserEventsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurgeUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PurgeUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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. 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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The force to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PurgeUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurgeUserEventsRequest.Builder
Overrides