DeletionRequest
@RequiresApi(value = 26)
class DeletionRequest
Deletion Request.
Summary
Nested types |
|---|
@RequiresApi(value = 26)Builder for {@link DeletionRequest} objects. |
Constants |
|
|---|---|
const Int |
Deletion mode to delete all data associated with the selected records. |
const Int |
Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records. |
const Int |
Match behavior option to delete the supplied params (Origin/Domains). |
const Int |
Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else. |
Public constructors |
|---|
Public properties |
|
|---|---|
Int |
Set the deletion mode for the supplied params. |
List<Uri> |
the list of domain URI which will be used for matching. |
Instant |
|
Int |
Set the match behavior for the supplied params. |
List<Uri> |
the list of origin URI which will be used for matching. |
Instant |
|
Constants
DELETION_MODE_ALL
const val DELETION_MODE_ALL = 0: Int
Deletion mode to delete all data associated with the selected records.
DELETION_MODE_EXCLUDE_INTERNAL_DATA
const val DELETION_MODE_EXCLUDE_INTERNAL_DATA = 1: Int
Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records.
MATCH_BEHAVIOR_DELETE
const val MATCH_BEHAVIOR_DELETE = 0: Int
Match behavior option to delete the supplied params (Origin/Domains).
MATCH_BEHAVIOR_PRESERVE
const val MATCH_BEHAVIOR_PRESERVE = 1: Int
Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else.
Public constructors
DeletionRequest
DeletionRequest(
deletionMode: Int,
matchBehavior: Int,
start: Instant = Instant.MIN,
end: Instant = Instant.MAX,
domainUris: List<Uri> = emptyList(),
originUris: List<Uri> = emptyList()
)
| Parameters | |
|---|---|
deletionMode: Int |
Set the deletion mode for the supplied params. |
matchBehavior: Int |
Set the match behavior for the supplied params. |
start: Instant = Instant.MIN |
|
end: Instant = Instant.MAX |
|
domainUris: List<Uri> = emptyList() |
the list of domain URI which will be used for matching. These will be matched with records using the same domain or any subdomains. E.g. If domainUri is {@code https://example.com}, then {@code https://a.example.com}, {@code https://example.com} and {@code https://b.example.com} will match; {@code https://abcexample.com} will NOT match. A null or empty list will match everything. |
originUris: List<Uri> = emptyList() |
the list of origin URI which will be used for matching. These will be matched with records using the same origin only, i.e. subdomains won't match. E.g. If originUri is {@code https://a.example.com}, then {@code https://a.example.com} will match; {@code https://example.com}, {@code https://b.example.com} and {@code https://abcexample.com} will NOT match. A null or empty list will match everything. |
Public functions
Public properties
deletionMode
val deletionMode: Int
Set the deletion mode for the supplied params. DELETION_MODE_ALL: All data associated with the selected records will be deleted. DELETION_MODE_EXCLUDE_INTERNAL_DATA: All data except the internal system data (e.g. rate limits) associated with the selected records will be deleted.
domainUris
val domainUris: List<Uri>
the list of domain URI which will be used for matching. These will be matched with records using the same domain or any subdomains. E.g. If domainUri is {@code https://example.com}, then {@code https://a.example.com}, {@code https://example.com} and {@code https://b.example.com} will match; {@code https://abcexample.com} will NOT match. A null or empty list will match everything.
end
val end: Instant
Instant Set the end of the deletion range. Not setting this or passing in java.time.Instant#MAX will cause everything from the specified start until the newest record to be deleted.
matchBehavior
val matchBehavior: Int
Set the match behavior for the supplied params. MATCH_BEHAVIOR_DELETE: This option will use the supplied params (Origin URIs & Domain URIs) for selecting records for deletion. MATCH_BEHAVIOR_PRESERVE: This option will preserve the data associated with the supplied params (Origin URIs & Domain URIs) and select remaining records for deletion.
originUris
val originUris: List<Uri>
the list of origin URI which will be used for matching. These will be matched with records using the same origin only, i.e. subdomains won't match. E.g. If originUri is {@code https://a.example.com}, then {@code https://a.example.com} will match; {@code https://example.com}, {@code https://b.example.com} and {@code https://abcexample.com} will NOT match. A null or empty list will match everything.