ai.grakn.client

Class TaskClient

java.lang.Object

ai.grakn.client.Client

ai.grakn.client.TaskClient

public class TaskClient
extends Client

Client for interacting with tasks on engine

Author:

Felix Chapman, alexandraorth

Method Summary

Modifier and Type	Method and Description
ai.grakn.engine.TaskStatus	getStatus(ai.grakn.engine.TaskId id) Get the status of a given task on the server
static TaskClient	of(String host, int port)
ai.grakn.engine.TaskId	sendTask(Class<?> taskClass, String creator, java.time.Instant runAt, java.time.Duration interval, mjson.Json configuration) Submit a task to run on an Grakn Engine server
boolean	stopTask(ai.grakn.engine.TaskId id) Stop a task using the given ID.

Methods inherited from class ai.grakn.client.Client

convert, exceptionFrom, serverIsRunning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static TaskClient of(String host,
                            int port)

sendTask

public ai.grakn.engine.TaskId sendTask(Class<?> taskClass,
                                       String creator,
                                       java.time.Instant runAt,
                                       java.time.Duration interval,
                                       mjson.Json configuration)

Submit a task to run on an Grakn Engine server

Parameters:

taskClass - Class of the Task to run

creator - Class creating the task

runAt - Time at which the task should be executed

interval - Interval at which the task should recur, can be null

configuration - Data on which to execute the task

Returns:

Identifier of the submitted task that will be executed on a server

getStatus

public ai.grakn.engine.TaskStatus getStatus(ai.grakn.engine.TaskId id)

Get the status of a given task on the server

Parameters:

id - Identifier of the task to get status of

Returns:

Status of the specified task

Throws:

ai.grakn.exception.EngineStorageException - When the specified task has not yet been stored by the server

stopTask

public boolean stopTask(ai.grakn.engine.TaskId id)

Stop a task using the given ID.

Parameters:

id - the ID of the task to stop