Class CollectUserEventRequest (2.14.0)

Version 2.14.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public final class CollectUserEventRequest extends GeneratedMessageV3 implements CollectUserEventRequestOrBuilder

Request message for CollectUserEvent method.

Protobuf type google.cloud.retail.v2.CollectUserEventRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CollectUserEventRequest

Implements

CollectUserEventRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ETS_FIELD_NUMBER

public static final int ETS_FIELD_NUMBER

Field Value

Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value

Type	Description
int

PREBUILT_RULE_FIELD_NUMBER

public static final int PREBUILT_RULE_FIELD_NUMBER

Field Value

Type	Description
int

RAW_JSON_FIELD_NUMBER

public static final int RAW_JSON_FIELD_NUMBER

Field Value

Type	Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

Field Value

Type	Description
int

USER_EVENT_FIELD_NUMBER

public static final int USER_EVENT_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static CollectUserEventRequest getDefaultInstance()

Returns

Type	Description
CollectUserEventRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static CollectUserEventRequest.Builder newBuilder()

Returns

Type	Description
CollectUserEventRequest.Builder

newBuilder(CollectUserEventRequest prototype)

public static CollectUserEventRequest.Builder newBuilder(CollectUserEventRequest prototype)

Parameter

Name	Description
prototype	CollectUserEventRequest

Returns

Type	Description
CollectUserEventRequest.Builder

parseDelimitedFrom(InputStream input)

public static CollectUserEventRequest parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static CollectUserEventRequest parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CollectUserEventRequest parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CollectUserEventRequest parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static CollectUserEventRequest parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static CollectUserEventRequest parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CollectUserEventRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CollectUserEventRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CollectUserEventRequest> parser()

Returns

Type	Description
Parser<CollectUserEventRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getConversionRuleCase()

public CollectUserEventRequest.ConversionRuleCase getConversionRuleCase()

Returns

Type	Description
CollectUserEventRequest.ConversionRuleCase

getDefaultInstanceForType()

public CollectUserEventRequest getDefaultInstanceForType()

Returns

Type	Description
CollectUserEventRequest

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;

Returns

Type	Description
long	The ets.

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];

Returns

Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<CollectUserEventRequest> getParserForType()

Returns

Type	Description
Parser<CollectUserEventRequest>

Overrides

GeneratedMessageV3.getParserForType()

getPrebuiltRule()

public String getPrebuiltRule()

The prebuilt rule name that can convert a specific type of raw_json. For example: "default_schema/v1.0"

string prebuilt_rule = 6;

Returns

Type	Description
String	The prebuiltRule.

getPrebuiltRuleBytes()

public ByteString getPrebuiltRuleBytes()

The prebuilt rule name that can convert a specific type of raw_json. For example: "default_schema/v1.0"

string prebuilt_rule = 6;

Returns

Type	Description
ByteString	The bytes for prebuiltRule.

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;

Returns

Type	Description
String	The rawJson.

getRawJsonBytes()

public 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;

Returns

Type	Description
ByteString	The bytes for rawJson.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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;

Returns

Type	Description
String	The uri.

getUriBytes()

public 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;

Returns

Type	Description
ByteString	The bytes for uri.

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];

Returns

Type	Description
String	The userEvent.

getUserEventBytes()

public 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];

Returns

Type	Description
ByteString	The bytes for userEvent.

hasPrebuiltRule()

public boolean hasPrebuiltRule()

The prebuilt rule name that can convert a specific type of raw_json. For example: "default_schema/v1.0"

string prebuilt_rule = 6;

Returns

Type	Description
boolean	Whether the prebuiltRule field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CollectUserEventRequest.Builder newBuilderForType()

Returns

Type	Description
CollectUserEventRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CollectUserEventRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CollectUserEventRequest.Builder toBuilder()

Returns

Type	Description
CollectUserEventRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException