Package com.google.cloud.discoveryengine.v1beta

Class PurgeUserEventsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>
com.google.cloud.discoveryengine.v1beta.PurgeUserEventsRequest.Builder
All Implemented Interfaces:
PurgeUserEventsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PurgeUserEventsRequest
public static final class PurgeUserEventsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder> implements PurgeUserEventsRequestOrBuilder
 Request message for PurgeUserEvents method.
Protobuf type google.cloud.discoveryengine.v1beta.PurgeUserEventsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>

    • clear

      public PurgeUserEventsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>

    • getDefaultInstanceForType

      public PurgeUserEventsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public PurgeUserEventsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public PurgeUserEventsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>

    • mergeFrom

      public PurgeUserEventsRequest.Builder mergeFrom(PurgeUserEventsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PurgeUserEventsRequest.Builder>

    • mergeFrom

      public PurgeUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeUserEventsRequest.Builder>
      Throws:
      IOException

    • getParent

      public String getParent()
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public PurgeUserEventsRequest.Builder setParent(String value)
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public PurgeUserEventsRequest.Builder clearParent()
       Required. The resource name of the catalog under which the events are
 created. The format is
 `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      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/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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][google.cloud.discoveryengine.v1beta.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];
      Specified by:
      getFilter in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.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];
      Specified by:
      getFilterBytes in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      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][google.cloud.discoveryengine.v1beta.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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • 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][google.cloud.discoveryengine.v1beta.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:
      This builder for chaining.

    • setFilterBytes

      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. The eligible fields for filtering are:

 * `eventType`: Double quoted
 [UserEvent.event_type][google.cloud.discoveryengine.v1beta.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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getForce in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The force.

    • setForce

      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;
      Parameters:
      value - The force to set.
      Returns:
      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:
      This builder for chaining.