ExecuteOutput.Builder


public static final class ExecuteOutput.Builder
extends Object

java.lang.Object
   ↳ android.adservices.ondevicepersonalization.ExecuteOutput.Builder


A builder for ExecuteOutput

Summary

Public constructors

Builder()

Public methods

ExecuteOutput.Builder addEventLogRecord(EventLogRecord value)
ExecuteOutput build()

Builds the instance.

ExecuteOutput.Builder setEventLogRecords(List<EventLogRecord> value)

A list of EventLogRecord objects to be written to the EVENTS table.

ExecuteOutput.Builder setOutputData(byte... value)

A byte array that an IsolatedService may optionally return to to a calling app, by setting this field to a non-null value.

ExecuteOutput.Builder setRenderingConfig(RenderingConfig value)

A RenderingConfig object that contains information about the content to be rendered in the client app view.

ExecuteOutput.Builder setRequestLogRecord(RequestLogRecord value)

Persistent data to be written to the REQUESTS table after IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver) completes.

Inherited methods

Public constructors

Builder

Added in API level 35
public Builder ()

Public methods

addEventLogRecord

Added in API level 35
public ExecuteOutput.Builder addEventLogRecord (EventLogRecord value)

Parameters
value EventLogRecord: This value cannot be null.

Returns
ExecuteOutput.Builder This value cannot be null.

build

Added in API level 35
public ExecuteOutput build ()

Builds the instance. This builder should not be touched after calling this!

Returns
ExecuteOutput This value cannot be null.

setEventLogRecords

Added in API level 35
public ExecuteOutput.Builder setEventLogRecords (List<EventLogRecord> value)

A list of EventLogRecord objects to be written to the EVENTS table. Each EventLogRecord must be associated with an existing RequestLogRecord in the REQUESTS table, specified using EventLogRecord.Builder#setRequestLogRecord(RequestLogRecord). If the RequestLogRecord is not specified, the EventLogRecord will not be written.

Parameters
value List: This value cannot be null.

Returns
ExecuteOutput.Builder This value cannot be null.

setOutputData

Added in API level 35
public ExecuteOutput.Builder setOutputData (byte... value)

A byte array that an IsolatedService may optionally return to to a calling app, by setting this field to a non-null value. The contents of this array will be returned to the caller of OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) if returning data from isolated processes is allowed by policy and the (calling app package, isolated service package) pair is present in an allowlist that permits data to be returned.

Parameters
value byte: This value may be null.

Returns
ExecuteOutput.Builder

setRenderingConfig

Added in API level 35
public ExecuteOutput.Builder setRenderingConfig (RenderingConfig value)

A RenderingConfig object that contains information about the content to be rendered in the client app view. Can be null if no content is to be rendered.

Parameters
value RenderingConfig: This value may be null.

Returns
ExecuteOutput.Builder

setRequestLogRecord

Added in API level 35
public ExecuteOutput.Builder setRequestLogRecord (RequestLogRecord value)

Persistent data to be written to the REQUESTS table after IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver) completes. If null, no persistent data will be written.

Parameters
value RequestLogRecord: This value may be null.

Returns
ExecuteOutput.Builder