Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-request/Job/ below:

Job | ArcGIS REST JS

Jobs represent long running processing tasks running on ArcGIS Services. Typically these represent complex analysis tasks such as geoprocessing tasks, logistics analysis such as fleet routing or spatial analysis tasks.

To create a Job, use the Job.submitJob method which will return an instance of the Job class with a unique id.

If you have an existing job you can use Job.serialize and Job.deserialize to save job information as a string and recreate the job to get results later.

Use dark colors for code blocks Copy

1
2
3
4
5
6
7
8
9
import { Job,  JOB_STATUSES  } from "@esri/arcgis-rest-request";

const job  = async Job.submitJob(options);

// will automatically wait for job completion and get results when the job is finished.
job.getAllResults().then((results) => {console.log(results)})

// watch for all status updates
job.on("status", ({jobStatus}) => {console.log(job.status)})

By default event monitoring is started when you call Job.waitForCompletion, Job.getAllResults or, Job.getResult and stops automatically when those promises complete. Use Job.startEventMonitoring and Job.stopEventMonitoring to manually start and stop event monitoring outside those methods. Starting monitoring with Job.startEventMonitoring will not stop monitoring when Job.waitForCompletion, Job.getAllResults or, Job.getResult complete.

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

The job id indicating the specific job.

The base URL of the job.

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

The job id indicating the specific job.

The base URL of the job.

Returns true if the job is polling for status changes.

The rate at which event monitoring is occurring in milliseconds.

Returns true if the job is polling for status changes.

The rate at which event monitoring is occurring in milliseconds.

Cancels the job request and voids the job.

Gets all the results from a successful job by ordering all the result paramUrl requests and calling each of them until all of them are complete and returns an object with all the results.

Retrieves the status of the current job.

Get the specific results of a successful job by result name. To get all results see Job.getAllResults.

A handler that will remove a listener after its emitted and returns a custom handler.

A handler that listens for an eventName and returns custom handler.

A handler that listens for an event once and returns a custom handler.

Converts the Job to a JSON string. You can rehydrate the state of the Job with Job.deserialize.

Starts the event polling if the user enables the startMonitoring param.

Stops the event polling rate. This is can only be enabled if the user calls this method directly.

Formats the requestOptions to JSON format.

Checks for job status and if the job status is successful it resolves the job information. Otherwise will throw a ArcGISJobError if it encounters a cancelled or failure status in the job.

Creates a new instance of Job from an existing job id.

Submits a job request that will return a new instance of Job.

Cancels the job request and voids the job.

An object that has job id, job status and messages array sequencing the status of the cancellation being submitted and completed.

Gets all the results from a successful job by ordering all the result paramUrl requests and calling each of them until all of them are complete and returns an object with all the results.

If monitoring is disabled it will be enabled until the job classes resolves or rejects this promise.

Use dark colors for code blocks Copy

1
2
3
4
5
6
7
8
9
10
Job.submitJob(options)
 .then((job) => {
   return job.getAllResults();
 }).then(allResults => {
   console.log(allResults);
 }).catch(e => {
   if(e.name === "ArcGISJobError") {
     console.log("Something went wrong while running the job", e.jobInfo);
   }
 })

Will throw a ArcGISJobError if it encounters a cancelled or failure status in the job.

An object representing all the results from a job.

Retrieves the status of the current job.

An object with the job id and jobStatus.

Get the specific results of a successful job by result name. To get all results see Job.getAllResults.

If monitoring is disabled it will be enabled until the job classes resolves or rejects this promise.

Use dark colors for code blocks Copy

1
2
3
4
5
6
7
8
9
10
Job.submitJob(options)
 .then((job) => {
   return job.getResult("result_name")
 }).then(result => {
   console.log(result);
 }).catch(e => {
   if(e.name === "ArcGISJobError") {
     console.log("Something went wrong while running the job", e.jobInfo);
   }
 })

Will throw a ArcGISJobError if it encounters a cancelled or failure status in the job.

The name of the result that you want to retrieve.

An object representing the individual result of the job.

A handler that will remove a listener after its emitted and returns a custom handler.

A string of what event to listen for.

A function of what to do when eventName was called.

A handler that listens for an eventName and returns custom handler.

A string of what event to listen for.

A function of what to do when eventName was called.

A handler that listens for an event once and returns a custom handler.

A string of what event to listen for.

A function of what to do when eventName was called.

Converts the Job to a JSON string. You can rehydrate the state of the Job with Job.deserialize.

A JSON string representing the Job.

Starts the event polling if the user enables the startMonitoring param.

Able to pass in a specific number or will default to 5000.

Stops the event polling rate. This is can only be enabled if the user calls this method directly.

Formats the requestOptions to JSON format.

The Job as a plain JavaScript object.

Checks for job status and if the job status is successful it resolves the job information. Otherwise will throw a ArcGISJobError if it encounters a cancelled or failure status in the job.

Use dark colors for code blocks Copy

1
2
3
4
5
6
7
8
9
10
11
12
Job.submitJob(options)
 .then((job) => {
   return job.waitForCompletion();
 })
.then((jobInfo) => {
   console.log("job finished", e.jobInfo);
 })
.catch(e => {
   if(e.name === "ArcGISJobError") {
     console.log("Something went wrong while running the job", e.jobInfo);
   }
 })

An object with a successful job status, id, and results.

static

static

Creates a new instance of Job from an existing job id.

Requires request endpoint url and id from an existing job id.

An new instance of Job class with options.

static

Submits a job request that will return a new instance of Job.

Requires url and params from requestOptions.

An new instance of Job class with the returned job id from submitJob request and requestOptions;

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4