ISubmitJobOptions

Interface

Options for Job.submitJob.

Properties

PropertyTypeNotes

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

any

Parameters necessary that are passed to the Job.submitJob method.

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.

params

Interface Property
params: any

Parameters necessary that are passed to the Job.submitJob method.

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.