Package com.inductiveautomation.ignition.common.script

Class ProjectScriptDiagnostic

java.lang.Object

com.inductiveautomation.ignition.common.script.ProjectScriptDiagnostic

public class ProjectScriptDiagnostic
extends Object

Used in the gateway status section to show information about gateway-run project scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProjectScriptDiagnostic.DiagnosticType
static class	ProjectScriptDiagnostic.GsonEncoder

Constructor Summary

Constructors

Constructor	Description
ProjectScriptDiagnostic(int type, String name, String projectName, boolean enabled, ScriptExecutionReport executionReport)	Deprecated.
ProjectScriptDiagnostic(ProjectScriptDiagnostic.DiagnosticType type, String name, String projectName, boolean enabled, ScriptExecutionReport executionReport)

Method Summary

Modifier and Type	Method	Description
String	get(String key)	Get some useful information about the script, depending on its type.
Map<String,String>	getDetails()
Long	getDuration()	The duration of the last execution of this script, in ms.
String	getErrorMessage()	The last error message produced when this script was executed.
Long	getLastExecution()	The timestamp when this script last executed, in ms.
String	getName()
String	getProjectName()
int	getType()
boolean	isEnabled()
void	put(String key, String value)

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectScriptDiagnostic

@Deprecated
public ProjectScriptDiagnostic(int type,
 String name,
 String projectName,
 boolean enabled,
 ScriptExecutionReport executionReport)

Deprecated.

Deprecated; prefer the constructor that accepts a ProjectScriptDiagnostic.DiagnosticType instead.

ProjectScriptDiagnostic

public ProjectScriptDiagnostic(ProjectScriptDiagnostic.DiagnosticType type,
 String name,
 String projectName,
 boolean enabled,
 ScriptExecutionReport executionReport)

Method Details

getType

public int getType()

getName

public String getName()

get

public String get(String key)

Get some useful information about the script, depending on its type.

getDetails

public Map<String,String> getDetails()

put

public void put(String key,
 String value)

getProjectName

public String getProjectName()

getLastExecution

public Long getLastExecution()

The timestamp when this script last executed, in ms.

getDuration

public Long getDuration()

The duration of the last execution of this script, in ms.

Returns:

null if the script has not run.

getErrorMessage

public String getErrorMessage()

The last error message produced when this script was executed.

Returns:

null if the script has not run, or if there was no error.

isEnabled

public boolean isEnabled()