Class EventDetail (0.31.0)

public final class EventDetail extends GeneratedMessageV3 implements EventDetailOrBuilder

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

Static Fields

EVENT_ATTRIBUTES_FIELD_NUMBER

public static final int EVENT_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

EXPERIMENT_IDS_FIELD_NUMBER

public static final int EXPERIMENT_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_VIEW_ID_FIELD_NUMBER

public static final int PAGE_VIEW_ID_FIELD_NUMBER
Field Value
TypeDescription
int

RECOMMENDATION_TOKEN_FIELD_NUMBER

public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

REFERRER_URI_FIELD_NUMBER

public static final int REFERRER_URI_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EventDetail getDefaultInstance()
Returns
TypeDescription
EventDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EventDetail.Builder newBuilder()
Returns
TypeDescription
EventDetail.Builder

newBuilder(EventDetail prototype)

public static EventDetail.Builder newBuilder(EventDetail prototype)
Parameter
NameDescription
prototypeEventDetail
Returns
TypeDescription
EventDetail.Builder

parseDelimitedFrom(InputStream input)

public static EventDetail parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EventDetail parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EventDetail parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EventDetail parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EventDetail parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EventDetail parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EventDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EventDetail> parser()
Returns
TypeDescription
Parser<EventDetail>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EventDetail getDefaultInstanceForType()
Returns
TypeDescription
EventDetail

getEventAttributes()

public FeatureMap getEventAttributes()

Optional. Extra user event features to include in the recommendation model.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

.google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FeatureMap

The eventAttributes.

getEventAttributesOrBuilder()

public FeatureMapOrBuilder getEventAttributesOrBuilder()

Optional. Extra user event features to include in the recommendation model.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

.google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FeatureMapOrBuilder

getExperimentIds(int index)

public String getExperimentIds(int index)

Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).

repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The experimentIds at the given index.

getExperimentIdsBytes(int index)

public ByteString getExperimentIdsBytes(int index)

Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).

repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.