Class CollectUserEventRequest (2.44.0)

public final class CollectUserEventRequest extends GeneratedMessageV3 implements CollectUserEventRequestOrBuilder

Request message for CollectUserEvent method.

Protobuf type google.cloud.retail.v2.CollectUserEventRequest

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

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

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

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: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Returns
Type Description
boolean

Whether the prebuiltRule field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CollectUserEventRequest.Builder toBuilder()
Returns
Type Description
CollectUserEventRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException