import Task from 'gsf-js-client-sdk/dist/Task.js'

public class | source

Task

The Task class is used to submit and inspect tasks.

Constructor Summary

Public Constructor
public	constructor(service: Service, taskName: string)

Public Members
public	name: string The task name.
public	service: Service The parent service.

Private Members
private	_client: *

Public Methods
public	info(): Promise<TaskInfo, error> Retrieves the task information.
public	submit(submitOptions: SubmitOptions, progressCallback: function(info: JobProgressInfo), startedCallback: function(info: JobStartedInfo)): Promise<Job, error> Submits the job.
public	submitAndWait(submitOptions: SubmitOptions, progressCallback: function(info: JobProgressInfo), startedCallback: function(info: JobStartedInfo)): Promise<JobResults, error> Submits the job and waits for results.

The task name.

The parent service.

Retrieves the task information.

Returns a promise to the TaskInfo object.

Submits the job.

Name	Type	Attribute	Description
submitOptions	SubmitOptions		The job submit options.
progressCallback	function(info: JobProgressInfo)	optional	The callback to handle job progress.
startedCallback	function(info: JobStartedInfo)	optional	The callback that is called when the job starts. For more reliable job started information, listen to the GSF JobStarted events as this callback may not always get called. In some cases the job can start before the callback is registered.

Returns a promise to a Job object.

Submits the job and waits for results. Resolves the promise if the job succeeds and rejects the promise if the job fails.

Name	Type	Attribute	Description
submitOptions	SubmitOptions		The job submit options.
progressCallback	function(info: JobProgressInfo)	optional	The callback to handle job progress.
startedCallback	function(info: JobStartedInfo)	optional	The callback that is called when the job starts. For more reliable job started information, listen to the GSF JobStarted events as this callback may not always get called. In some cases the job can start before the callback is registered.

Returns a promise to a Job object.