Sign in
gitpod.v1.EnvironmentAutomationService

UpdateTaskExecutionStatus

Updates the status of a task execution. Only the environment executing a task execution is expected to call this function.

Use this method to:

  • Report execution progress
  • Update step status
  • Set failure messages
  • Provide log URLs

Examples

  • Update execution status:

    Updates status with step information.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
steps:
  - id: "step-1"
    phase: TASK_EXECUTION_PHASE_SUCCEEDED
logUrl: "https://logs.gitpod.io/task-123"

  • Report failure:

    Updates status with failure information.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
failureMessage: "Build failed due to missing dependencies"
steps:
  - id: "step-1"
    phase: TASK_EXECUTION_PHASE_FAILED
    failureMessage: "npm install failed"
post/gitpod.v1.EnvironmentAutomationService/UpdateTaskExecutionStatus

Request body

failureMessagestring nullable

failure_message marks the task execution as failed and provides a message explaining the failure. If an individual step has failed, callers are NOT expected to set this message; only if the task execution as a whole has failed/cannot be started.

idstring uuid
logUrlstring nullable

log_url is the URL to the logs of the task's steps. If this is empty, the task either has no logs or has not yet started.

Response

Success

GitpodV1UpdateTaskExecutionStatusResponse required

Changes

Changed in 3 of the 18 revisions of this API.227

  • ca9a49ac7fbb1See the full diff
    • ○

      added the new optional request property steps/items/output

      new-optional-request-property

    This revision also has 43 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3655d5ad0ac3216See the full diff
    • ▲

      request property steps/items/phase was restricted to a list of enum values

      request-property-became-enum

    • ▲

      the steps/items/phase request property type/format changed from / to string/

      request-property-type-changed

    • ●

      removed gitpod.v1.TaskExecutionPhase from the steps/items/phase request property allOf list

      request-property-all-of-removed

    • ○

      added the new TASK_EXECUTION_PHASE_FAILED enum value to the request property steps/items/phase

      request-property-enum-value-added

    • ○

      added the new TASK_EXECUTION_PHASE_PENDING enum value to the request property steps/items/phase

      request-property-enum-value-added

    • ○

      added the new TASK_EXECUTION_PHASE_RUNNING enum value to the request property steps/items/phase

      request-property-enum-value-added

    • ○

      added the new TASK_EXECUTION_PHASE_STOPPED enum value to the request property steps/items/phase

      request-property-enum-value-added

    • ○

      added the new TASK_EXECUTION_PHASE_SUCCEEDED enum value to the request property steps/items/phase

      request-property-enum-value-added

    • ○

      added the new TASK_EXECUTION_PHASE_UNSPECIFIED enum value to the request property steps/items/phase

      request-property-enum-value-added

  • cd6a05ae99d21See the full diff
    • ●

      removed the optional property detail from the response with the default status

      response-optional-property-removed