blueocean-plugin/blueocean-rest/src/main/java/io/jenkins/blueocean/rest/model/BlueQueueItem.java

55 lines
1.3 KiB
Java

package io.jenkins.blueocean.rest.model;
import io.jenkins.blueocean.rest.annotation.Capability;
import org.kohsuke.stapler.export.Exported;
import java.text.SimpleDateFormat;
import java.util.Date;
import static io.jenkins.blueocean.commons.JsonConverter.DATE_FORMAT_STRING;
/**
* This class models an item waiting in the queue for an executor so that
* it can run.
*
* @author Ivan Meredith
*/
@Capability("io.jenkins.blueocean.rest.model.BlueQueueItem")
public abstract class BlueQueueItem extends Resource {
public static final String QUEUED_TIME = "queuedTime";
/**
* @return Id of the item in the queue. Much be unique in the queue of a pipeline
*/
@Exported
public abstract String getId();
@Exported
public abstract String getOrganization();
/**
*
* @return pipeline this queued item belongs too
*/
@Exported
public abstract String getPipeline();
/**
*
* @return Time the item entered the queue.
*/
public abstract Date getQueuedTime();
@Exported(name=QUEUED_TIME)
public final String getQueuedTimeString(){
return new SimpleDateFormat(DATE_FORMAT_STRING).format(getQueuedTime());
}
/**
*
* @return The expected build number of the build. This may change.
*/
@Exported
public abstract int getExpectedBuildNumber();
}