EventLogRecord


public final class EventLogRecord
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.ondevicepersonalization.EventLogRecord


Data to be logged in the EVENTS table. Each record in the EVENTS table is associated with one row from an existing RequestLogRecord in the requests table RequestLogRecord#getRows(). The purpose of the EVENTS table is to add supplemental information to logged data from a prior request, e.g., logging an event when a link in a rendered WebView is clicked IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver). The contents of the EVENTS table can be consumed by Federated Learning facilitated model training, or Federated Analytics facilitated cross-device statistical analysis.

Summary

Nested classes

class EventLogRecord.Builder

A builder for EventLogRecord 

Inherited constants

Fields

public static final Creator<EventLogRecord> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

ContentValues getData()

Additional data to be logged.

RequestLogRecord getRequestLogRecord()

The existing RequestLogRecord that this payload should be associated with.

int getRowIndex()

The index of the row in an existing RequestLogRecord that this payload should be associated with.

Instant getTime()

Returns the timestamp of this record.

int getType()

The service-assigned identifier that identifies this payload.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<EventLogRecord> CREATOR

Public methods

describeContents

Added in API level 35
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 35
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getData

Added in API level 35
public ContentValues getData ()

Additional data to be logged. Can be null if no additional data needs to be written as part of the event, and only the occurrence of the event needs to be logged.

Returns
ContentValues

getRequestLogRecord

Added in API level 35
public RequestLogRecord getRequestLogRecord ()

The existing RequestLogRecord that this payload should be associated with. In an implementation of IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver), this should be set to a value returned by LogReader#getRequests(Instant, Instant). In an implementation of IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver), this should be set to null because the payload will be automatically associated with the current RequestLogRecord.

Returns
RequestLogRecord

getRowIndex

Added in API level 35
public int getRowIndex ()

The index of the row in an existing RequestLogRecord that this payload should be associated with.

Returns
int Value is 0 or greater

getTime

Added in API level 35
public Instant getTime ()

Returns the timestamp of this record.

Returns
Instant This value cannot be null.

getType

Added in API level 35
public int getType ()

The service-assigned identifier that identifies this payload. Each row in RequestLogRecord can be associated with up to one event of a specified type. The platform drops events if another event with the same type already exists for a row in RequestLogRecord. Must be >0 and <128. This allows up to 127 events to be written for each row in RequestLogRecord. If unspecified, the default is 1.

Returns
int Value is between 1 and 127 inclusive

hashCode

Added in API level 35
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES