Skip to main content
Version: Next

RequestQueueClientRequestToAdd

A request as the caller submits it to the queue.

The API assigns the id, so it is dropped. The unique key and the URL the caller has to supply come required from RequestQueueClientRequestSchema.

Hierarchy

Index

Properties

Properties

optionalinheritederrorMessages

errorMessages?: null | string[]
null

Error messages recorded from failed processing attempts.

optionalinheritedhandledAt

handledAt?: null | Date

Format: date-time

2019-06-16T10:23:31.607Z

The timestamp when the request was marked as handled, if applicable.

optionalinheritedheaders

headers?: null | Record<string, unknown>
null

HTTP headers sent with the request.

optionalinheritedloadedUrl

loadedUrl?: null | string
https://apify.com/jobs

The final URL that was loaded, after redirects (if any).

optionalinheritedmethod

method?: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH

optionalinheritednoRetry

noRetry?: null | boolean
false

Indicates whether the request should not be retried if processing fails.

optionalinheritedpayload

payload?: null | string | Record<string, unknown>
null

The request payload, typically used with POST or PUT requests.

optionalinheritedretryCount

retryCount?: number

inheriteduniqueKey

uniqueKey: string

inheritedurl

url: string

optionalinheriteduserData

userData?: {}

Type declaration

    Page Options