Class DataDeletionResponseItemAttributes

Deletion attribute for data deletion response.

Hierarchy

  • DataDeletionResponseItemAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
createdAt: string

Creation time of the deletion request.

createdBy: string

User who created the deletion request.

customerMessage?: string

A message for the customer regarding the deletion request, if any.

displayedTotal: number

Total number of elements to be deleted as displayed to the user.

errorCategory?: string

The category of the error for the deletion request, if any.

fromTime: number

Start of requested time window, milliseconds since Unix epoch.

indexes?: string[]

List of indexes for the search. If not provided, the search is performed in all indexes.

isCreated: boolean

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

orgId: number

Organization ID.

product: string

Product name.

query: string

Query for creating a data deletion request.

recoverableUntil?: string

Time when the recovery period for the deletion request ends. Before this time, you can cancel the request and recover the data. After this time, permanent deletion begins, and the status changes to deleting within a few minutes. This field is returned only for in_progress requests when listing deletion requests, and is omitted if the value cannot be determined.

source?: string

The source of the deletion request.

startingAt: string

Starting time of the process to delete the requested data.

status: string

Status of the deletion request.

toTime: number

End of requested time window, milliseconds since Unix epoch.

totalUnrestricted: number

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

updatedAt: string

Update time of the deletion request.

Generated using TypeDoc