Package com.google.cloud.recommendationengine.v1beta1

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.recommendationengine.v1beta1.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.recommendationengine.v1beta1.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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
      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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
      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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
      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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
      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 event_store under which the events are
 created. The format is
 `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
      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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: 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];
      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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: 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];
      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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: 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];
      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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: 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:
      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. Empty
 string filter is not allowed. This filter can also be used with
 ListUserEvents API to list events that will be deleted. The eligible fields
 for filtering are:
 * eventType - UserEvent.eventType field of type string.
 * eventTime - in ISO 8601 "zulu" format.
 * visitorId - field of type string. Specifying this will delete all events
 associated with a visitor.
 * userId - field of type string. Specifying this will delete all events
 associated with a user.
 Example 1: Deleting all events in a time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
 "2012-04-23T18:30:43.511Z"`
 Example 2: Deleting specific eventType in time range.
 `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
 Example 3: 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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getForce

      public boolean getForce()
       Optional. The default value is false. Override this flag to true to
 actually perform the purge. If the field is not set to true, a sampling of
 events to be deleted will be returned.
      bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getForce in interface PurgeUserEventsRequestOrBuilder
      Returns:
      The force.

    • setForce

      public PurgeUserEventsRequest.Builder setForce(boolean value)
       Optional. The default value is false. Override this flag to true to
 actually perform the purge. If the field is not set to true, a sampling of
 events to be deleted will be returned.
      bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The force to set.
      Returns:
      This builder for chaining.

    • clearForce

      public PurgeUserEventsRequest.Builder clearForce()
       Optional. The default value is false. Override this flag to true to
 actually perform the purge. If the field is not set to true, a sampling of
 events to be deleted will be returned.
      bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.