org.springframework.boot.buildpack.platform.docker

Class ProgressUpdateEvent

java.lang.Object

org.springframework.boot.buildpack.platform.docker.UpdateEvent

org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent

Direct Known Subclasses:

ImageProgressUpdateEvent, LoadImageUpdateEvent

public abstract class ProgressUpdateEvent
extends UpdateEvent

An UpdateEvent that includes progress information.

Since:

2.3.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressUpdateEvent.ProgressDetail Provide details about the progress of a task.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgressUpdateEvent(String status, ProgressUpdateEvent.ProgressDetail progressDetail, String progress)

Method Summary

Modifier and Type	Method and Description
String	getProgress() Return a text based progress bar if progress information is available.
ProgressUpdateEvent.ProgressDetail	getProgressDetail() Return progress details if available.
String	getStatus() Return the status for the update.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressUpdateEvent

protected ProgressUpdateEvent(String status,
                              ProgressUpdateEvent.ProgressDetail progressDetail,
                              String progress)

Method Detail

getStatus

public String getStatus()

Return the status for the update. For example, "Extracting" or "Downloading".

Returns:

the status of the update.

getProgressDetail

public ProgressUpdateEvent.ProgressDetail getProgressDetail()

Return progress details if available.

Returns:

progress details or null

getProgress

public String getProgress()

Return a text based progress bar if progress information is available.

Returns:

the progress bar or null