com.atlassian.scheduler.status

Interface RunDetails

All Known Implementing Classes:

RunDetailsImpl

@PublicApi
public interface RunDetails

A report of the result from a specific attempt to run a job. The job status may optionally also include a status message for informational or troubleshooting reasons.

Since:

v1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXIMUM_MESSAGE_LENGTH The maximum length that is permitted for the message string returned in a JobRunnerResponse.

Method Summary

Modifier and Type	Method and Description
long	getDurationInMillis() Returns the duration (in milliseconds) that the job took to complete.
String	getMessage() Returns any additional message that the job would like to report about this job run.
RunOutcome	getRunOutcome() Returns the overall result of the job
Date	getStartTime() Returns the starting time of this job run.

Field Detail

MAXIMUM_MESSAGE_LENGTH

static final int MAXIMUM_MESSAGE_LENGTH

The maximum length that is permitted for the message string returned in a JobRunnerResponse. Any return value that exceeds this length (255 chars) is silently truncated.

See Also:

Constant Field Values

Method Detail

getStartTime

@Nonnull
Date getStartTime()

Returns the starting time of this job run.

Returns:

the starting time of this job run.

getDurationInMillis

long getDurationInMillis()

Returns the duration (in milliseconds) that the job took to complete.

Returns:

the duration (in milliseconds) that the job took to complete.

getRunOutcome

@Nonnull
RunOutcome getRunOutcome()

Returns the overall result of the job

Returns:

the overall result of the job

getMessage

@Nonnull
String getMessage()

Returns any additional message that the job would like to report about this job run. If the job failed, this will generally include a brief summary of the exception that was thrown. This may be blank for successful statuses, but it will never be null.

Returns:

any additional message that the job would like to report about its status.