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
  • Constructor Details

  • Method Details

    • 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