ExecuteOutput.Builder
public
static
final
class
ExecuteOutput.Builder
extends Object
| java.lang.Object | |
| ↳ | android.adservices.ondevicepersonalization.ExecuteOutput.Builder |
This class is deprecated.
The ODP APIs are deprecated and will not be supported in future Android
releases. There is no direct replacement API available. Developers currently integrated with
these APIs must cease further integration efforts. For comprehensive details regarding this
deprecation and the future roadmap of Privacy Sandbox on Android, please consult the
official Privacy Sandbox developer documentation and announcements:
https://privacysandbox.google.com
A builder for ExecuteOutput
Summary
Public constructors | |
|---|---|
Builder()
|
|
Public methods | |
|---|---|
ExecuteOutput.Builder
|
addEventLogRecord(EventLogRecord value)
|
ExecuteOutput
|
build()
Builds the instance. |
ExecuteOutput.Builder
|
setBestValue(int value)
An integer value that an |
ExecuteOutput.Builder
|
setEventLogRecords(List<EventLogRecord> value)
A list of |
ExecuteOutput.Builder
|
setOutputData(byte... value)
A byte array that an |
ExecuteOutput.Builder
|
setRenderingConfig(RenderingConfig value)
A |
ExecuteOutput.Builder
|
setRequestLogRecord(RequestLogRecord value)
Persistent data to be written to the REQUESTS table after
|
Inherited methods | |
|---|---|
Public constructors
Public methods
addEventLogRecord
public ExecuteOutput.Builder addEventLogRecord (EventLogRecord value)
| Parameters | |
|---|---|
value |
EventLogRecord: This value cannot be null. |
| Returns | |
|---|---|
ExecuteOutput.Builder |
This value cannot be null. |
See also:
build
public ExecuteOutput build ()
Builds the instance. This builder should not be touched after calling this!
| Returns | |
|---|---|
ExecuteOutput |
This value cannot be null. |
setBestValue
public ExecuteOutput.Builder setBestValue (int value)
An integer value that an IsolatedService may optionally return to a calling app,
by setting this field to the value between 0 and ExecuteInIsolatedServiceRequest.OutputSpec.getMaxIntValue(). The noise will be added to
the value of this field before returned to the caller of OnDevicePersonalizationManager.executeInIsolatedService. In order to get this field, the
(calling app package, isolated service package) pair must be present in an allowlist that
permits data to be returned and ExecuteInIsolatedServiceRequest.OutputSpec.buildBestValueSpec is set.
| Parameters | |
|---|---|
value |
int: Value is 0 or greater |
| Returns | |
|---|---|
ExecuteOutput.Builder |
This value cannot be null. |
setEventLogRecords
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
public ExecuteOutput.Builder setOutputData (byte... value)
A byte array that an IsolatedService may optionally return 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
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
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 |
|