EventLogRecord
class EventLogRecord : Parcelable
kotlin.Any | |
↳ | 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 | |
---|---|
A builder for |
Inherited constants | |
---|---|
Public methods | |
---|---|
Int | |
Boolean |
Indicates whether some other object is "equal to" this one. |
ContentValues? |
getData() Additional data to be logged. |
RequestLogRecord? |
The existing |
Int |
The index of the row in an existing |
Instant |
getTime() Returns the timestamp of this record. |
Int |
getType() The service-assigned identifier that identifies this payload. |
Int |
hashCode() |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<EventLogRecord!> |
Public methods
describeContents
fun describeContents(): Int
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
equals
fun equals(other: Any?): Boolean
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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 | |
---|---|
obj |
the reference object with which to compare. |
o |
This value may be null . |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getData
fun getData(): ContentValues?
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.
getRequestLogRecord
fun getRequestLogRecord(): RequestLogRecord?
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
.
getRowIndex
fun getRowIndex(): Int
The index of the row in an existing RequestLogRecord
that this payload should be associated with.
Return | |
---|---|
Int |
Value is 0 or greater |
getTime
fun getTime(): Instant
Returns the timestamp of this record.
Return | |
---|---|
Instant |
This value cannot be null . |
getType
fun getType(): Int
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.
Return | |
---|---|
Int |
Value is between 1 and 127 inclusive |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |