Package com.atlassian.bamboo.rest.model.admin.scheduler

Class RestScheduledJob

java.lang.Object

com.atlassian.bamboo.rest.model.AbstractRestModel

com.atlassian.bamboo.rest.model.admin.scheduler.RestScheduledJob

public class RestScheduledJob
extends AbstractRestModel

Model of a Scheduled Job used for REST resources to allow serialization/deserialization to/from JSON and XML.

Field Summary

Fields

Modifier and Type	Field	Description
static com.google.common.base.Function<ScheduledJob,RestScheduledJob>	FROM_SCHEDULED_JOB	Deprecated. since 5.11, use RestScheduledJob() as function reference

Fields inherited from class com.atlassian.bamboo.rest.model.AbstractRestModel

self

Constructor Summary

Constructors

Constructor	Description
RestScheduledJob()	Default constructor.
RestScheduledJob(@NotNull ScheduledJob scheduledJob)	Copy constructor.
RestScheduledJob(@NotNull String name, @NotNull String groupName, @Nullable Date nextScheduledTime)	Parameterized constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getGroupName()	Gets the name of the group the job belongs to.
@NotNull String	getName()	Gets the name of the job.
@Nullable Date	getNextScheduledTime()	Gets the next scheduled time the job will run.
@NotNull ScheduledJob	toScheduledJob()	Returns a ScheduledJob representation of the object.

Methods inherited from class com.atlassian.bamboo.rest.model.AbstractRestModel

getSelf, setSelf

Methods inherited from class java.lang.Object

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

Field Details

FROM_SCHEDULED_JOB

@Deprecated
public static com.google.common.base.Function<ScheduledJob,RestScheduledJob> FROM_SCHEDULED_JOB

Deprecated.

since 5.11, use RestScheduledJob() as function reference

Constructor Details

RestScheduledJob

public RestScheduledJob()

Default constructor.

RestScheduledJob

public RestScheduledJob(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String groupName,
 @Nullable
 @Nullable Date nextScheduledTime)

Parameterized constructor.

Parameters:

name - the name of the job

groupName - the name of the group the job belongs to

nextScheduledTime - the next time the job is scheduled to run

RestScheduledJob

public RestScheduledJob(@NotNull
 @NotNull ScheduledJob scheduledJob)

Copy constructor.

Parameters:

scheduledJob - the scheduled job to be made a copy of

Method Details

toScheduledJob

@NotNull
public @NotNull ScheduledJob toScheduledJob()

Returns a ScheduledJob representation of the object.

Returns:

a scheduled job representation

getName

@NotNull
public @NotNull String getName()

Gets the name of the job.

This should be removed in a future version its here as using this with RestAssured is ignoring the annotations on the class and serializing using XmlAccessType.Property by default.

Returns:

the name

getGroupName

@NotNull
public @NotNull String getGroupName()

Gets the name of the group the job belongs to.

This should be removed in a future version its here as using this with RestAssured is ignoring the annotations on the class and serializing using XmlAccessType.Property by default.

Returns:

the name of the group

getNextScheduledTime

@Nullable
public @Nullable Date getNextScheduledTime()

Gets the next scheduled time the job will run.

This should be removed in a future version its here as using this with RestAssured is ignoring the annotations on the class and serializing using XmlAccessType.Property by default.

Returns:

the next scheduled time