Builder

Builder

Builder()

build

fun build(): DeletionRequest

Builds a DeletionRequest instance.

setDeletionMode

fun setDeletionMode(deletionMode: Int): DeletionRequest.Builder

Set the match behavior 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.

setDomainUris

fun setDomainUris(domainUris: MutableList<Uri!>?): DeletionRequest.Builder

Set 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 https://example.com, then https://a.example.com, https://example.com and https://b.example.com will match; https://abcexample.com will NOT match.

setEnd

fun setEnd(end: Instant): DeletionRequest.Builder

Set the end of the deletion range. Passing in java.time.Instant#MAX will cause everything from the specified start until the newest record to be deleted. No set end will default to java.time.Instant#MAX.

setMatchBehavior

fun setMatchBehavior(matchBehavior: Int): DeletionRequest.Builder

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.

setOriginUris

fun setOriginUris(originUris: MutableList<Uri!>?): DeletionRequest.Builder

Set 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 https://a.example.com, then https://a.example.com will match; https://example.com, https://b.example.com and https://abcexample.com will NOT match.

setStart

fun setStart(start: Instant): DeletionRequest.Builder

Set the start of the deletion range. Passing in java.time.Instant#MIN will cause everything from the oldest record to the specified end be deleted. No set start will default to java.time.Instant#MIN.