IJobOptions

Interface

Options for creating a new Job.

Properties

PropertyTypeNotes

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

string

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

number

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

boolean

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

string

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

authentication

optional
Interface Property
authentication: string | IAuthenticationManager

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

id

Interface Property
id: string

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

pollingRate

optional
Interface Property
pollingRate: number

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

startMonitoring

optional
Interface Property
startMonitoring: boolean

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

url

Interface Property
url: string

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.