IJobOptions

Interface

Options for creating a new Job.

Property	Type	Notes
`authentication`	`string \| IAuthenticationManager`	Authentication manager or access token to use for all job requests.
`id`	`string`	The ID of the job. Can be used to rehydrate an instance of `Job` with `Job.fromExistingJob` or `Job.deserialize`.
`pollingRate`	`number`	Rate in milliseconds to poll for job status changes. Defaults to `2000`.
`startMonitoring`	`boolean`	Automatically monitor the job for status changes once it is created. Defaults to `false`.
`url`	`string`	The base URL of the job without `/submitJob` or a trailing job id.

optional

Interface Property

authentication: string | IAuthenticationManager

Authentication manager or access token to use for all job requests.

Interface Property

id: string

The ID of the job. Can be used to rehydrate an instance of Job with Job.fromExistingJob or Job.deserialize.

optional

Interface Property

pollingRate: number

Rate in milliseconds to poll for job status changes. Defaults to 2000.

optional

Interface Property

startMonitoring: boolean

Automatically monitor the job for status changes once it is created. Defaults to false.

Interface Property

url: string

The base URL of the job without /submitJob or a trailing job id.