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

GetUpdateEventsResponse

    GetUpdateEventsResponse contains the engine events for am update.

    Properties

    • events array[EngineEvent] required
      Events are returned sorted by their internal sequence number (not exposed to the API). So the last Event in the slice is the most recent event which was stored in the database. (Should sort identical to timestamp, but may not if we support parallel writes.)
    • ↳ timestamp integer required
      Timestamp of the event (seconds).
    • ↳ type string required
      Type describes which payload object is associated with the event, such that in JavaScript event[event.type] is never undefined/null.
    • ↳ cancelEvent AppCancelEvent optional
      Present when type is cancelEvent.
    • ↳ stdoutEvent AppStdoutEngineEvent optional
      Present when type is stdoutEvent.
    • ↳ diagnosticEvent AppDiagnosticEvent optional
      Present when type is diagnosticEvent.
    • ↳ preludeEvent AppPreludeEvent optional
      Present when type is preludeEvent.
    • ↳ summaryEvent AppSummaryEvent optional
      Present when type is summaryEvent.
    • ↳ resourcePreEvent AppResourcePreEvent optional
      Present when type is resourcePreEvent.
    • ↳ resOutputsEvent AppResOutputsEvent optional
      Present when type is resOutputsEvent.
    • ↳ resOpFailedEvent AppResOpFailedEvent optional
      Present when type is resOpFailedEvent.
    • ↳ policyEvent AppPolicyEvent optional
      Present when type is policyEvent.
    • ↳ policyRemediationEvent AppPolicyRemediationEvent optional
      Present when type is policyRemediationEvent.
    • ↳ policyLoadEvent AppPolicyLoadEvent optional
      Present when type is policyLoadEvent.
    • ↳ policyAnalyzeSummaryEvent AppPolicyAnalyzeSummaryEvent optional
      Present when type is policyAnalyzeSummaryEvent.
    • ↳ policyRemediateSummaryEvent AppPolicyRemediateSummaryEvent optional
      Present when type is policyRemediateSummaryEvent.
    • ↳ policyAnalyzeStackSummaryEvent AppPolicyAnalyzeStackSummaryEvent optional
      Present when type is policyAnalyzeStackSummaryEvent.
    • ↳ startDebuggingEvent AppStartDebuggingEvent optional
      Present when type is startDebuggingEvent.
    • ↳ progressEvent AppProgressEvent optional
      Present when type is progressEvent.
    • ↳ errorEvent AppErrorEvent optional
      Present when type is errorEvent.
    • continuationToken string required
      ContinuationToken is an opaque value the client can send to fetch more recent events if the update is still in progress. Will be nil once all events have been returned and the update is complete.