Package dev.le_app.mcss_api_java

Class RunCommandsJob

java.lang.Object

dev.le_app.mcss_api_java.Job

dev.le_app.mcss_api_java.RunCommandsJob

public class RunCommandsJob
extends Job

Represents a job.

Constructor Summary

Constructors

Constructor	Description
RunCommandsJob(MCSSApi api, String GUID, String TaskID)	Create a new job.

Method Summary

Modifier and Type	Method	Description
ServerAction	getAction()	Get the action of the task.
String	getBackupGUID()	Get the Backup ID of the backup executed by the task
ArrayList<String>	getCommands()	Get an array list of commands that the task executes
Job	setAction(ServerAction action)	Set the new action to execute
Job	setBackupGUID(String backupGUID)	Set the new backup to execute
Job	setCommands(String... commands)	Update the commands to be executed by the task

Methods inherited from class java.lang.Object

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

Constructor Details

RunCommandsJob

public RunCommandsJob(MCSSApi api,
 String GUID,
 String TaskID)

Create a new job.

Parameters:

api - The API instance.

GUID - The GUID of the server.

TaskID - The ID of the task.

Method Details

getAction

public ServerAction getAction()

Description copied from class: Job

Get the action of the task.

Specified by:

getAction in class Job

Returns:

The action of the task.

getCommands

public ArrayList<String> getCommands()
                              throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException

Get an array list of commands that the task executes

Specified by:

getCommands in class Job

Returns:

ArrayList of commands

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server is not found

IOException - if there is an IO error (e.g. server is offline)

APIInvalidTaskDetailsException - if the task is not found

getBackupGUID

public String getBackupGUID()

Description copied from class: Job

Get the Backup ID of the backup executed by the task

Specified by:

getBackupGUID in class Job

Returns:

The Backup ID of the backup executed by the task

setAction

public Job setAction(ServerAction action)

Description copied from class: Job

Set the new action to execute

Specified by:

setAction in class Job

Parameters:

action - The new action to execute

Returns:

this.Job (used for concatenating)

setCommands

public Job setCommands(String... commands)
                throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException

Update the commands to be executed by the task

Specified by:

setCommands in class Job

Parameters:

commands - list of commands to be executed by the task

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server is not found

APIInvalidTaskDetailsException - if the task is not found

IOException - if there is an IO error (e.g. server is offline)

setBackupGUID

public Job setBackupGUID(String backupGUID)

Description copied from class: Job

Set the new backup to execute

Specified by:

setBackupGUID in class Job

Parameters:

backupGUID - The new backup to execute

Returns:

this.Job (used for concatenating)