Package dev.le_app.mcss_api_java

Class ServerActionJob

java.lang.Object

dev.le_app.mcss_api_java.Job

dev.le_app.mcss_api_java.ServerActionJob

public class ServerActionJob
extends Job

Represents a job.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ServerAction	getAction()	Get the action of the job.
String	getBackupGUID()	Get the Backup ID of the backup executed by the task
ArrayList<String>	getCommands()	Get the commands of the task.
Job	setAction(ServerAction action)	The action to be performed on the server.
Job	setBackupGUID(String backupGUID)	Set the new backup to execute
Job	setCommands(String... commands)	Set the new commands to execute

Methods inherited from class java.lang.Object

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

Constructor Details

ServerActionJob

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

Create a new ServerActionJob.

Parameters:

api - The API instance.

GUID - The GUID of the server.

TaskID - The ID of the task.

Method Details

getAction

public ServerAction getAction()
                       throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException

Get the action of the job.

Specified by:

getAction in class Job

Returns:

The action of the job.

Throws:

APIUnauthorizedException - If the API key is not valid.

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.

getCommands

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

Description copied from class: Job

Get the commands of the task.

Specified by:

getCommands in class Job

Returns:

The commands of the task.

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

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

APIInvalidTaskDetailsException - If the task details are invalid.

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)
              throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException

The action to be performed on the server.

Specified by:

setAction in class Job

Parameters:

action - the action to be performed on the server.

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - If the API key is not valid.

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.

setCommands

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

Description copied from class: Job

Set the new commands to execute

Specified by:

setCommands in class Job

Parameters:

commands - The new commands to execute

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

APIInvalidTaskDetailsException - If the task details are invalid.

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)