json.schema.governance.workflows.elements.triggers.periodicBatchEntityTrigger.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PeriodicBatchEntityTriggerDefinition",
  "description": "Periodic Batch Entity Trigger.",
  "javaType": "org.openmetadata.schema.governance.workflows.elements.nodes.trigger.PeriodicBatchEntityTriggerDefinition",
  "type": "object",
  "definitions": {
    "config": {
      "description": "Entity Event Trigger Configuration.",
      "type": "object",
      "properties": {
        "schedule": {
          "$ref": "../../../../entity/applications/app.json#definitions/appSchedule",
          "description": "Defines the schedule of the Periodic Trigger."
        },
        "entityType": {
          "description": "Entity Type for which it should be triggered.",
          "type": "string"
        },
        "filters": {
          "description": "Search Filters to filter down the entities fetched.",
          "type": "string"
        },
        "batchSize": {
          "description": "Number of Entities to process at once.",
          "type": "integer",
          "default": 500
        }
      },
      "required": ["schedule", "entityType", "filters"],
      "additionalProperties": false
    }
  },
  "properties": {
    "type": {
      "type": "string",
      "default": "periodicBatchEntityTrigger"
    },
    "config": {
      "$ref": "#/definitions/config"
    },
    "output": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": ["relatedEntity"],
      "additionalItems": false,
      "minItems": 1,
      "maxItems": 1,
      "uniqueItems": true
    }
  },
  "additionalProperties": false
}