schema.states.parallelstate.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of serverlessworkflow-api Show documentation

Java SDK for Serverless Workflow Specification

There is a newer version: 7.0.0-alpha5.1

Show newest version

{
  "type": "object",
  "javaType": "io.serverlessworkflow.api.states.ParallelState",
  "javaInterfaces": [
    "io.serverlessworkflow.api.interfaces.State"
  ],
  "description": "Consists of a number of states that are executed in parallel",
  "extends": {
    "$ref": "defaultstate.json"
  },
  "properties": {
    "branches": {
      "type": "array",
      "description": "Branch Definitions",
      "items": {
        "type": "object",
        "$ref": "../branches/branch.json"
      }
    },
    "completionType": {
      "type" : "string",
      "enum": ["allOf", "atLeast"],
      "description": "Option types on how to complete branch execution.",
      "default": "allOf"
    },
    "numCompleted": {
      "type": "string",
      "default": "0",
      "description": "Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition."
    },
    "usedForCompensation": {
      "type": "boolean",
      "default": false,
      "description": "If true, this state is used to compensate another state. Default is false"
    }
  },
  "required": [
    "branches"
  ]
}