Documentation

Job
in package

Job class for asynchronous requests.

Will hold information on the queue a document has been submitted to.

Table of Contents

Properties

$availableAt  : DateTimeImmutable|null
$error  : array<string|int, mixed>|null
$id  : string|null
$issuedAt  : DateTimeImmutable|null
$millisecsTaken  : int|null
$status  : string|null

Methods

__construct()  : mixed
__toString()  : string

Properties

$availableAt

public DateTimeImmutable|null $availableAt

Timestamp of the request after it has been completed.

$error

public array<string|int, mixed>|null $error

Information about an error that occurred during the job processing.

$id

public string|null $id

ID of the job sent by the API in response to an enqueue request.

$issuedAt

public DateTimeImmutable|null $issuedAt

Timestamp of the request reception by the API.

$millisecsTaken

public int|null $millisecsTaken

Time (ms) taken for the request to be processed by the API.

$status

public string|null $status

Status of the request, as seen by the API.

Methods

__construct()

public __construct(array<string|int, mixed> $rawResponse) : mixed
Parameters
$rawResponse : array<string|int, mixed>

Raw prediction array.

Tags
throws
MindeeApiException

Throws if a date is faulty.

__toString()

public __toString() : string
Return values
string

        
On this page

Search results