Class CollectUserEventRequest (2.20.0)
Version 2.20.0keyboard_arrow_down
public final class CollectUserEventRequest extends GeneratedMessageV3 implements CollectUserEventRequestOrBuilder
Request message for CollectUserEvent method.
Protobuf type google.cloud.retail.v2alpha.CollectUserEventRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CollectUserEventRequest . Builder newBuilder ()
newBuilder(CollectUserEventRequest prototype)
public static CollectUserEventRequest . Builder newBuilder ( CollectUserEventRequest prototype )
public static CollectUserEventRequest parseDelimitedFrom ( InputStream input )
public static CollectUserEventRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CollectUserEventRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CollectUserEventRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CollectUserEventRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CollectUserEventRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CollectUserEventRequest parseFrom ( CodedInputStream input )
public static CollectUserEventRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CollectUserEventRequest parseFrom ( InputStream input )
public static CollectUserEventRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CollectUserEventRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CollectUserEventRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CollectUserEventRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getConversionRuleCase()
public CollectUserEventRequest . ConversionRuleCase getConversionRuleCase ()
getDefaultInstanceForType()
public CollectUserEventRequest getDefaultInstanceForType ()
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 ()
Overrides
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;
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: "ga4_bq" rule for the GA4 user event schema.
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
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: "ga4_bq" rule for the GA4 user event schema.
string prebuilt_rule = 6;
Returns
Type Description
boolean Whether the prebuiltRule field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CollectUserEventRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CollectUserEventRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public CollectUserEventRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
