Task with block

TaskWithBlock refers to a task object with block information but without detailed step information. A task is rendered in XML as a <task> element containing attributes and child elements.

Attributes

id

The ID of the task

failures

The total number of failures in this task. It's possible that a step fails multiple times, so this value can be higher than the number of steps.

owner

The user that owns the task

state

The current state of the task: PENDING, QUEUED, EXECUTED, EXECUTING, FAILING, FAILED, STOPPING, STOPPED, ABORTING, ABORTED, DONE or CANCELLED.

Child elements

<activeBlocks>

For an active task, the blocks that are currently being executed.

<description>

Textual description of the task.

<startDate>

The date when the task was started. Format: the ISO 8601 profile used in XML

<completionDate>

The date when the task was completed. Format: ISO 8601 profile used in XML

<scheduledDate>

Only included when the task is scheduled. It defines the date when the task was is scheduled. Format: ISO 8601 profile used in XML

<metadata>

Contains entries from the metadata map. Each entry is an XML element, where the element name is the key of the entry, and the content is the value. Currently supported: application, environment and version

<block>

Contains the root block with all the nested blocks. For a detailed description of blocks see BlockState.

Example

<task id="7c7c1f7b-15dd-4d10-9844-fc6384ee22f7" failures="0" owner="admin">
  <description>Initial deployment of Environments/0smallEnv0/AnimalZoo-ear</description>
  <startDate>2014-01-29T10:53:12.981+0100</startDate>
  <activeBlocks>
    <active>1</active>
    <active>1-1</active>
    <active>1-1-1</active>
    <active>1-1-2</active>
  </activeBlocks>
  <metadata>
    <application>AnimalZoo-ear</application>
    <environment>0smallEnv0</environment>
    <taskType>INITIAL</taskType>
    <environment_id>Environments/0smallEnv0</environment_id>
    <version>1.0</version>
  </metadata>
  <block id="1" state="EXECUTING" description="Deploying AnimalZoo-ear 1.0 on environment 0smallEnv0" parallel="false">
    <block id="1-1" state="EXECUTING" description="Deploying group default" parallel="true">
      <block id="1-1-1" state="EXECUTING" description="Deploying on container smallServer0"/>
      <block id="1-1-2" state="EXECUTING" description="Deploying on container smallServer1"/>
    </block>
    <block id="1-2" state="PENDING" description="Deploying group 1" parallel="true">
      <block id="1-2-1" state="PENDING" description="Deploying on container tinyServer0"/>
      <block id="1-2-2" state="PENDING" description="Deploying on container newServer0"/>
    </block>
  </block>
</task>