Documentation

Job
in package

Job information for a V2 polling attempt.

Table of Contents

Properties

$alias  : string|null
$createdAt  : DateTime|null
$error  : ErrorResponse|null
$filename  : string
$id  : string
$modelId  : string
$pollingUrl  : string
$resultUrl  : string|null
$status  : string
$webhooks  : array<string|int, JobWebhook>

Methods

__construct()  : mixed
parseDate()  : DateTime|null
Parse a date string into a DateTime object.

Properties

$alias

public string|null $alias

Optional alias for the file.

$createdAt

public DateTime|null $createdAt

Timestamp of the job creation.

$filename

public string $filename

Name for the file.

$id

public string $id

Job ID.

$modelId

public string $modelId

ID of the model.

$pollingUrl

public string $pollingUrl

URL to poll for the job status.

$resultUrl

public string|null $resultUrl

URL to poll for the job result, redirects to the result if available.

$status

public string $status

Status of the job.

$webhooks

public array<string|int, JobWebhook> $webhooks

ID of webhooks associated with the job.

Methods

__construct()

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

Raw server response array.

parseDate()

Parse a date string into a DateTime object.

private parseDate(string|null $dateString) : DateTime|null
Parameters
$dateString : string|null

Date string to parse.

Return values
DateTime|null

        
On this page

Search results