Class JobEnvironment

java.lang.Object

org.tasktide.core.model.job_env.JobEnvironment

All Implemented Interfaces:

TaskTideModel<JobEnvironment>

@Entity
public class JobEnvironment
extends Object
implements TaskTideModel<JobEnvironment>

Data class to hold collection of host meta-data running job such as where Hostname/Environment etc, job Id, OS, and.

A single JobEnviroment can relate to multiple WorkItem, but a single WorkItem does not relate to multiple JobEnvs.

Constructor Summary

Constructors

Constructor	Description
JobEnvironment()	For Jakarta compatibility
JobEnvironment(String id, JobType type, String jobId, int arrayInd)	Construct
JobEnvironment(String id, JobType type, String jobId, String hostname, String hostOS, String javaVersion, int arrayInd, JobState jobState)	Construct with all arguments
JobEnvironment(String id, JobType type, String jobId, String hostname, String hostOS, String javaVersion, int arrayInd, JobState jobState, CustomAnnotation anno)	Construct with all arguments

Method Summary

Modifier and Type	Method	Description
CustomAnnotation	getAnnotations()	Get annotations
int	getArrayInd()	Get index in job array
String	getCollection()	Returns the JobType
String	getHostname()	Get hostname, defined from inet address
String	getHostOS()	Get host os, defined from properties os.name+os.version
String	getId()	Get Id for job environment
String	getJavaVersion()	Get java version
String	getJobId()	Get job Id
JobState	getJobState()	Gets current JobState
JobType	getJobType()	Get job jobType
String	getState()	Gets current JobState
Object	getValueFromField(String field)	Fetches value for queried field
static JobEnvironment	makeJobEnvironment(String id, JobType type, String jobId, int arrayInd, String hostname, String hostOS, String javaVersion, JobState jobState, CustomAnnotation anno)	Static method supporting json deserialization through which makeJobEnvironment is created
void	resetModel()	Not implemented
void	setAnnotations(CustomAnnotation anno)	Set annotation provided
void	setArrayInd(int arrayInd)	Sets job arrray index
void	setHostname(String hostname)	Get hostname from inet address
void	setHostOS(String hostOS)	Set host os, defined from properties os.name+os.version
void	setId(String id)	Set Id
void	setJavaVersion(String javaVersion)	Set java version
void	setJobId(String jobId)	Sets job Id
void	setJobState(JobState jobState)	Sets a new JobState
void	setJobType(JobType jobType)	Set JobType
String	toJson()	Represent as JSON-B string
String	toJsonDoc()	Represent as JSON-B Document
String	toString()	Represent as string

Methods inherited from class Object

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

Constructor Details

JobEnvironment

public JobEnvironment()

For Jakarta compatibility

JobEnvironment

public JobEnvironment(String id,
 JobType type,
 String jobId,
 int arrayInd)

Construct

Parameters:

id -

type -

jobId -

arrayInd -

JobEnvironment

public JobEnvironment(String id,
 JobType type,
 String jobId,
 String hostname,
 String hostOS,
 String javaVersion,
 int arrayInd,
 JobState jobState)

Construct with all arguments

Parameters:

id -

type -

jobId -

hostname -

hostOS -

javaVersion -

arrayInd -

jobState -

JobEnvironment

public JobEnvironment(String id,
 JobType type,
 String jobId,
 String hostname,
 String hostOS,
 String javaVersion,
 int arrayInd,
 JobState jobState,
 CustomAnnotation anno)

Construct with all arguments

Parameters:

id -

type -

jobId -

hostname -

hostOS -

javaVersion -

arrayInd -

jobState -

anno -

Method Details

makeJobEnvironment

public static JobEnvironment makeJobEnvironment(String id,
 JobType type,
 String jobId,
 int arrayInd,
 String hostname,
 String hostOS,
 String javaVersion,
 JobState jobState,
 CustomAnnotation anno)

Static method supporting json deserialization through which makeJobEnvironment is created

Parameters:

id -

type -

jobId -

arrayInd -

hostname -

hostOS -

javaVersion -

jobState -

anno -

Returns:

JobEnvironment

getJobType

public JobType getJobType()

Get job jobType

Returns:

JobType

getJobId

public String getJobId()

Get job Id

Returns:

String

getArrayInd

public int getArrayInd()

Get index in job array

Returns:

long

getHostname

public String getHostname()

Get hostname, defined from inet address

Returns:

String

setHostname

public void setHostname(String hostname)

Get hostname from inet address

Parameters:

hostname -

getHostOS

public String getHostOS()

Get host os, defined from properties os.name+os.version

Returns:

String

setHostOS

public void setHostOS(String hostOS)

Set host os, defined from properties os.name+os.version

Parameters:

hostOS -

getJavaVersion

public String getJavaVersion()

Get java version

Returns:

String

setJavaVersion

public void setJavaVersion(String javaVersion)

Set java version

Parameters:

javaVersion -

getId

public String getId()

Get Id for job environment

Specified by:

getId in interface TaskTideModel<JobEnvironment>

Returns:

String

setId

public void setId(String id)

Set Id

Parameters:

id -

setJobType

public void setJobType(JobType jobType)

Set JobType

Parameters:

jobType -

setJobId

public void setJobId(String jobId)

Sets job Id

Parameters:

jobId -

setArrayInd

public void setArrayInd(int arrayInd)

Sets job arrray index

Parameters:

arrayInd -

getAnnotations

public CustomAnnotation getAnnotations()

Get annotations

Specified by:

getAnnotations in interface TaskTideModel<JobEnvironment>

Returns:

CustomAnnotation

setAnnotations

public void setAnnotations(CustomAnnotation anno)

Set annotation provided

Specified by:

setAnnotations in interface TaskTideModel<JobEnvironment>

Parameters:

anno -

toJson

public String toJson()

Represent as JSON-B string

Specified by:

toJson in interface TaskTideModel<JobEnvironment>

Returns:

String

toJsonDoc

public String toJsonDoc()

Represent as JSON-B Document

Specified by:

toJsonDoc in interface TaskTideModel<JobEnvironment>

Returns:

String

getState

public String getState()

Gets current JobState

Specified by:

getState in interface TaskTideModel<JobEnvironment>

Returns:

String

getJobState

public JobState getJobState()

Gets current JobState

Returns:

JobState

setJobState

public void setJobState(JobState jobState)

Sets a new JobState

Parameters:

jobState -

getCollection

public String getCollection()

Returns the JobType

Specified by:

getCollection in interface TaskTideModel<JobEnvironment>

Returns:

String

resetModel

public void resetModel()

Not implemented

Specified by:

resetModel in interface TaskTideModel<JobEnvironment>

toString

public String toString()

Represent as string

Overrides:

toString in class Object

Returns:

String

getValueFromField

public Object getValueFromField(String field)

Fetches value for queried field

Specified by:

getValueFromField in interface TaskTideModel<JobEnvironment>

Parameters:

field -

Returns:

Object