com.atlassian.bitbucket.job

Interface Job

public interface Job

Represents a job that runs for some period of time doing some specific set of tasks on a single node in the cluster.

Since:

5.13

Method Summary

Modifier and Type	Method and Description
Optional<Instant>	getEndDate()
long	getId()
Optional<ApplicationUser>	getInitiator()
String	getNodeId()
Progress	getProgress()
Instant	getStartDate()
JobState	getState()
String	getType()
Instant	getUpdatedDate()
int	getVersion()

Method Detail

getId

long getId()

Returns:

the job's ID

getNodeId

@Nonnull
String getNodeId()

Returns:

the node the job is currently running on

getType

@Nonnull
String getType()

Returns:

a string representation of the type of this job. This is feature-specific and allows jobs to be categorised when querying to filter out jobs unrelated to the feature doing the query.

getInitiator

@Nonnull
Optional<ApplicationUser> getInitiator()

Returns:

the user who initiated the job or empty for system-initiated jobs

getStartDate

@Nonnull
Instant getStartDate()

Returns:

when the job was created and started

getUpdatedDate

@Nonnull
Instant getUpdatedDate()

Returns:

when the job details were last updated

getEndDate

@Nonnull
Optional<Instant> getEndDate()

Returns:

when the job was ended or empty if it has not started or is still running

getProgress

@Nonnull
Progress getProgress()

Returns:

the progress of the job

getState

@Nonnull
JobState getState()

Returns:

the current state of the job

getVersion

int getVersion()

Returns:

the current version of the job