Class ProgressUpdateEvent
java.lang.Object
org.springframework.boot.buildpack.platform.docker.UpdateEvent
org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent
- Direct Known Subclasses:
ImageProgressUpdateEvent
,LoadImageUpdateEvent
An
UpdateEvent
that includes progress information.- Since:
- 2.3.0
- Author:
- Phillip Webb
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Provide details about the progress of a task. -
Constructor Summary
ModifierConstructorDescriptionprotected
ProgressUpdateEvent
(String status, ProgressUpdateEvent.ProgressDetail progressDetail, String progress) -
Method Summary
Modifier and TypeMethodDescriptionReturn a text based progress bar if progress information is available.Return progress details if available.Return the status for the update.
-
Constructor Details
-
ProgressUpdateEvent
protected ProgressUpdateEvent(String status, ProgressUpdateEvent.ProgressDetail progressDetail, String progress)
-
-
Method Details
-
getStatus
Return the status for the update. For example, "Extracting" or "Downloading".- Returns:
- the status of the update.
-
getProgressDetail
Return progress details if available.- Returns:
- progress details or
null
-
getProgress
Return a text based progress bar if progress information is available.- Returns:
- the progress bar or
null
-