ExportDetails
in package
implements
TaskDetails
FinalYes
Index keys are the requested patterns while the task is enqueued, processing or failed.
Once it succeeds they become the matched index uids, and the snake_case matched_documents
key returned by the server is added to each entry.
Tags
Table of Contents
Interfaces
Properties
- $apiKey : string|null
- $indexes : array<string|int, mixed>
- $payloadSize : string|null
- $url : string
Methods
- __construct() : mixed
- fromArray() : self
Properties
$apiKey read-only
public
string|null
$apiKey
$indexes read-only
public
array<string|int, mixed>
$indexes
$payloadSize read-only
public
string|null
$payloadSize
$url read-only
public
string
$url
Methods
__construct()
public
__construct(string $url, non-empty-string|null $apiKey, non-empty-string|null $payloadSize, array<non-empty-string, RawExportIndexDetails> $indexes) : mixed
Parameters
- $url : string
- $apiKey : non-empty-string|null
-
masked by the server, e.g. "XXX..."
- $payloadSize : non-empty-string|null
-
human-readable size, e.g. "50 MiB"
- $indexes : array<non-empty-string, RawExportIndexDetails>
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>