com.google.cloud.retail.v2

Class CollectUserEventRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.CollectUserEventRequest

All Implemented Interfaces:

CollectUserEventRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CollectUserEventRequest
extends com.google.protobuf.GeneratedMessageV3
implements CollectUserEventRequestOrBuilder

 Request message for CollectUserEvent method.
 

Protobuf type google.cloud.retail.v2.CollectUserEventRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectUserEventRequest.Builder Request message for CollectUserEvent method.
static class	CollectUserEventRequest.ConversionRuleCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ETS_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	PREBUILT_RULE_FIELD_NUMBER
static int	RAW_JSON_FIELD_NUMBER
static int	URI_FIELD_NUMBER
static int	USER_EVENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CollectUserEventRequest.ConversionRuleCase	getConversionRuleCase()
static CollectUserEventRequest	getDefaultInstance()
CollectUserEventRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getEts() The event timestamp in milliseconds.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<CollectUserEventRequest>	getParserForType()
String	getPrebuiltRule() The prebuilt rule name that can convert a specific type of raw_json.
com.google.protobuf.ByteString	getPrebuiltRuleBytes() The prebuilt rule name that can convert a specific type of raw_json.
String	getRawJson() An arbitrary serialized JSON string that contains necessary information that can comprise a user event.
com.google.protobuf.ByteString	getRawJsonBytes() An arbitrary serialized JSON string that contains necessary information that can comprise a user event.
int	getSerializedSize()
String	getUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
com.google.protobuf.ByteString	getUriBytes() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
String	getUserEvent() Required.
com.google.protobuf.ByteString	getUserEventBytes() Required.
int	hashCode()
boolean	hasPrebuiltRule() The prebuilt rule name that can convert a specific type of raw_json.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CollectUserEventRequest.Builder	newBuilder()
static CollectUserEventRequest.Builder	newBuilder(CollectUserEventRequest prototype)
CollectUserEventRequest.Builder	newBuilderForType()
protected CollectUserEventRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CollectUserEventRequest	parseDelimitedFrom(InputStream input)
static CollectUserEventRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CollectUserEventRequest	parseFrom(byte[] data)
static CollectUserEventRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CollectUserEventRequest	parseFrom(ByteBuffer data)
static CollectUserEventRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CollectUserEventRequest	parseFrom(com.google.protobuf.ByteString data)
static CollectUserEventRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CollectUserEventRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static CollectUserEventRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CollectUserEventRequest	parseFrom(InputStream input)
static CollectUserEventRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CollectUserEventRequest>	parser()
CollectUserEventRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PREBUILT_RULE_FIELD_NUMBER

public static final int PREBUILT_RULE_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

USER_EVENT_FIELD_NUMBER

public static final int USER_EVENT_FIELD_NUMBER

See Also:

Constant Field Values

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

See Also:

Constant Field Values

ETS_FIELD_NUMBER

public static final int ETS_FIELD_NUMBER

See Also:

Constant Field Values

RAW_JSON_FIELD_NUMBER

public static final int RAW_JSON_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getConversionRuleCase

public CollectUserEventRequest.ConversionRuleCase getConversionRuleCase()

Specified by:

getConversionRuleCase in interface CollectUserEventRequestOrBuilder

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.

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.

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CollectUserEventRequest parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CollectUserEventRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static CollectUserEventRequest parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static CollectUserEventRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static CollectUserEventRequest parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static CollectUserEventRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static CollectUserEventRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public CollectUserEventRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CollectUserEventRequest.Builder newBuilder()

newBuilder

public static CollectUserEventRequest.Builder newBuilder(CollectUserEventRequest prototype)

toBuilder

public CollectUserEventRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CollectUserEventRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CollectUserEventRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<CollectUserEventRequest> parser()

getParserForType

public com.google.protobuf.Parser<CollectUserEventRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CollectUserEventRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder