1. Docs
2. Reference
3. REST API Docs
4. Schema
5. AppUpdateResults

UpdateResults returns a series of events and the current status of an update. The events can be filtered. See API call for more details.

Properties

• status enum required
  The current status
  Values:

  not started — NotStarted

  StatusNotStarted is returned when the Update has been created but not applied.

  requested — Requested

  StatusRequested is returned when the Update application has been requested but not started.

  running — Running

  StatusRunning is returned when the Update is in progress.

  failed — Failed

  StatusFailed is returned when the update has failed.

  succeeded — Succeeded

  StatusSucceeded is returned when the update has succeeded.

  cancelled — Cancelled

  UpdateStatusCancelled indicates that an update completed due to cancellation.

• events array[AppUpdateEvent] required
  List of events
• ↳ index string required
  The index
• ↳ kind enum required
  The kind
  Values:

  stdout — StdoutEvent

  StdoutEvent is used to mark the event being emitted to STDOUT.

  stderr — StderrEvent

  StderrEvent is used to mark the event being emitted to STDERR.

• ↳ fields map[string]object required
  The fields
• continuationToken string optional

  ContinuationToken is an opaque value used to indiciate the end of the returned update results. Pass it in the next request to obtain subsequent update events.

  The same continuation token may be returned if no new update events are available, but the update is still in-progress.

  A value of nil means that no new updates will be available. Everything has been returned to the client and the update has completed.