Package com.google.cloud.retail.v2alpha

Class CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • clear

        public CollectUserEventRequest.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<CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • clearField

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • clearOneof

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • setRepeatedField

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • addRepeatedField

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public CollectUserEventRequest.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<CollectUserEventRequest.Builder>
        Throws:
        IOException

      • hasPrebuiltRule

        public boolean hasPrebuiltRule()
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Specified by:
        hasPrebuiltRule in interface CollectUserEventRequestOrBuilder
        Returns:
        Whether the prebuiltRule field is set.

      • getPrebuiltRule

        public String getPrebuiltRule()
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Specified by:
        getPrebuiltRule in interface CollectUserEventRequestOrBuilder
        Returns:
        The prebuiltRule.

      • getPrebuiltRuleBytes

        public com.google.protobuf.ByteString getPrebuiltRuleBytes()
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Specified by:
        getPrebuiltRuleBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for prebuiltRule.

      • setPrebuiltRule

        public CollectUserEventRequest.Builder setPrebuiltRule​(String value)
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Parameters:
        value - The prebuiltRule to set.
        Returns:
        This builder for chaining.

      • clearPrebuiltRule

        public CollectUserEventRequest.Builder clearPrebuiltRule()
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Returns:
        This builder for chaining.

      • setPrebuiltRuleBytes

        public CollectUserEventRequest.Builder setPrebuiltRuleBytes​(com.google.protobuf.ByteString value)
         The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
        string prebuilt_rule = 6;
        Parameters:
        value - The bytes for prebuiltRule to set.
        Returns:
        This builder for chaining.

      • getParent

        public String getParent()
         Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParent in interface CollectUserEventRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParentBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public CollectUserEventRequest.Builder setParent​(String value)
         Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public CollectUserEventRequest.Builder clearParent()
         Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setParentBytes

        public CollectUserEventRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getUserEvent

        public String getUserEvent()
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEvent in interface CollectUserEventRequestOrBuilder
        Returns:
        The userEvent.

      • getUserEventBytes

        public com.google.protobuf.ByteString getUserEventBytes()
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEventBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for userEvent.

      • setUserEvent

        public CollectUserEventRequest.Builder setUserEvent​(String value)
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The userEvent to set.
        Returns:
        This builder for chaining.

      • clearUserEvent

        public CollectUserEventRequest.Builder clearUserEvent()
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setUserEventBytes

        public CollectUserEventRequest.Builder setUserEventBytes​(com.google.protobuf.ByteString value)
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for userEvent to set.
        Returns:
        This builder for chaining.

      • getUri

        public String getUri()
         The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
        string uri = 3;
        Specified by:
        getUri in interface CollectUserEventRequestOrBuilder
        Returns:
        The uri.

      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
        string uri = 3;
        Specified by:
        getUriBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for uri.

      • setUri

        public CollectUserEventRequest.Builder setUri​(String value)
         The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
        string uri = 3;
        Parameters:
        value - The uri to set.
        Returns:
        This builder for chaining.

      • clearUri

        public CollectUserEventRequest.Builder clearUri()
         The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
        string uri = 3;
        Returns:
        This builder for chaining.

      • setUriBytes

        public CollectUserEventRequest.Builder setUriBytes​(com.google.protobuf.ByteString value)
         The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
        string uri = 3;
        Parameters:
        value - The bytes for uri to set.
        Returns:
        This builder for chaining.

      • getEts

        public long getEts()
         The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
        int64 ets = 4;
        Specified by:
        getEts in interface CollectUserEventRequestOrBuilder
        Returns:
        The ets.

      • setEts

        public CollectUserEventRequest.Builder setEts​(long value)
         The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
        int64 ets = 4;
        Parameters:
        value - The ets to set.
        Returns:
        This builder for chaining.

      • clearEts

        public CollectUserEventRequest.Builder clearEts()
         The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
        int64 ets = 4;
        Returns:
        This builder for chaining.

      • getRawJson

        public String getRawJson()
         An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
        string raw_json = 5;
        Specified by:
        getRawJson in interface CollectUserEventRequestOrBuilder
        Returns:
        The rawJson.

      • getRawJsonBytes

        public com.google.protobuf.ByteString getRawJsonBytes()
         An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
        string raw_json = 5;
        Specified by:
        getRawJsonBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for rawJson.

      • setRawJson

        public CollectUserEventRequest.Builder setRawJson​(String value)
         An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
        string raw_json = 5;
        Parameters:
        value - The rawJson to set.
        Returns:
        This builder for chaining.

      • clearRawJson

        public CollectUserEventRequest.Builder clearRawJson()
         An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
        string raw_json = 5;
        Returns:
        This builder for chaining.

      • setRawJsonBytes

        public CollectUserEventRequest.Builder setRawJsonBytes​(com.google.protobuf.ByteString value)
         An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
        string raw_json = 5;
        Parameters:
        value - The bytes for rawJson to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final CollectUserEventRequest.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<CollectUserEventRequest.Builder>

      • mergeUnknownFields

        public final CollectUserEventRequest.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<CollectUserEventRequest.Builder>