Package com.google.cloud.retail.v2beta

Class PurgeUserEventsRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • clearField

        public PurgeUserEventsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>

      • clearOneof

        public PurgeUserEventsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>

      • setRepeatedField

        public PurgeUserEventsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>

      • addRepeatedField

        public PurgeUserEventsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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/${projectId}/locations/global/catalogs/${catalogId}`
        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/${projectId}/locations/global/catalogs/${catalogId}`
        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/${projectId}/locations/global/catalogs/${catalogId}`
        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/${projectId}/locations/global/catalogs/${catalogId}`
        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/${projectId}/locations/global/catalogs/${catalogId}`
        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. Empty string filter is not allowed. The
 eligible fields for filtering are:

 * `eventType`: Double quoted
 [UserEvent.event_type][google.cloud.retail.v2beta.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];
        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. Empty string filter is not allowed. The
 eligible fields for filtering are:

 * `eventType`: Double quoted
 [UserEvent.event_type][google.cloud.retail.v2beta.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];
        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. Empty string filter is not allowed. The
 eligible fields for filtering are:

 * `eventType`: Double quoted
 [UserEvent.event_type][google.cloud.retail.v2beta.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];
        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. Empty string filter is not allowed. The
 eligible fields for filtering are:

 * `eventType`: Double quoted
 [UserEvent.event_type][google.cloud.retail.v2beta.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:
        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. Empty string filter is not allowed. The
 eligible fields for filtering are:

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

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

      • setForce

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

      • setUnknownFields

        public final PurgeUserEventsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>

      • mergeUnknownFields

        public final PurgeUserEventsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeUserEventsRequest.Builder>