Added in API level 34
Also in Ad Services Extensions 4

Summary: Nested Classes | Constants | Methods | Inherited Methods

DeletionRequest

Kotlin |Java

public class DeletionRequest
extends Object

java.lang.Object
↳	android.adservices.measurement.DeletionRequest

Deletion Request.

Summary

Nested classes
`class`	`DeletionRequest.Builder` Builder for `DeletionRequest` objects.

Constants
`int`	`DELETION_MODE_ALL` Deletion mode to delete all data associated with the selected records.
`int`	`DELETION_MODE_EXCLUDE_INTERNAL_DATA` Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records.
`int`	`MATCH_BEHAVIOR_DELETE` Match behavior option to delete the supplied params (Origin/Domains).
`int`	`MATCH_BEHAVIOR_PRESERVE` Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else.

Public methods
`int`	`getDeletionMode()` Get the deletion mode.
`List<Uri>`	`getDomainUris()` Get the list of domain URIs.
`Instant`	`getEnd()` Get the end of the deletion range.
`int`	`getMatchBehavior()` Get the match behavior.
`List<Uri>`	`getOriginUris()` Get the list of origin URIs.
`Instant`	`getStart()` Get the start of the deletion range.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

DELETION_MODE_ALL

Added in API level 34
Also in Ad Services Extensions 4

public static final int DELETION_MODE_ALL

Deletion mode to delete all data associated with the selected records.

Constant Value: 0 (0x00000000)

DELETION_MODE_EXCLUDE_INTERNAL_DATA

Added in API level 34
Also in Ad Services Extensions 4

public static final int DELETION_MODE_EXCLUDE_INTERNAL_DATA

Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records.

Constant Value: 1 (0x00000001)

MATCH_BEHAVIOR_DELETE

Added in API level 34
Also in Ad Services Extensions 4

public static final int MATCH_BEHAVIOR_DELETE

Match behavior option to delete the supplied params (Origin/Domains).

Constant Value: 0 (0x00000000)

MATCH_BEHAVIOR_PRESERVE

Added in API level 34
Also in Ad Services Extensions 4

public static final int MATCH_BEHAVIOR_PRESERVE

Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else.

Constant Value: 1 (0x00000001)

Public methods

getDeletionMode

Added in API level 34
Also in Ad Services Extensions 4

public int getDeletionMode ()

Get the deletion mode.

Returns
`int`	Value is `DELETION_MODE_ALL`, or `DELETION_MODE_EXCLUDE_INTERNAL_DATA`

getDomainUris

Added in API level 34
Also in Ad Services Extensions 4

public List<Uri> getDomainUris ()

Get the list of domain URIs.

Returns
`List<Uri>`	This value cannot be `null`.

getEnd

Added in API level 34
Also in Ad Services Extensions 4

public Instant getEnd ()

Get the end of the deletion range.

Returns
`Instant`	This value cannot be `null`.

getMatchBehavior

Added in API level 34
Also in Ad Services Extensions 4

public int getMatchBehavior ()

Get the match behavior.

Returns
`int`	Value is `MATCH_BEHAVIOR_DELETE`, or `MATCH_BEHAVIOR_PRESERVE`

getOriginUris

Added in API level 34
Also in Ad Services Extensions 4

public List<Uri> getOriginUris ()

Get the list of origin URIs.

Returns
`List<Uri>`	This value cannot be `null`.

getStart

Added in API level 34
Also in Ad Services Extensions 4

public Instant getStart ()

Get the start of the deletion range.

Returns
`Instant`	This value cannot be `null`.

DeletionRequest

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

DELETION_MODE_ALL

DELETION_MODE_EXCLUDE_INTERNAL_DATA

MATCH_BEHAVIOR_DELETE

MATCH_BEHAVIOR_PRESERVE

Public methods

getDeletionMode

getDomainUris

getEnd

getMatchBehavior

getOriginUris

getStart