Skip to main content
Version: Next

DataflowDto

idstringrequired
Example: urn:uuid:dataflow-1
transferProcessIdstringrequired
Example: urn:uuid:provider:transfer-1
dataPlaneIdstringrequired
Example: urn:uuid:dp-1
datasetIdstring
Example: urn:uuid:dataset-1
statestringrequired

Possible values: [INITIALIZED, PREPARING, PREPARED, STARTING, STARTED, SUSPENDED, COMPLETED, TERMINATED]

Example: STARTED
dataAddress object
@typestringrequired

Possible values: [DataAddress]

endpointTypestringrequired
endpointstring
endpointProperties object[]
  • Array [
  • @typestringrequired

    Possible values: [EndpointProperty]

    namestringrequired
    valuestringrequired
  • ]
  • DataflowDto
    {
    "id": "urn:uuid:dataflow-1",
    "transferProcessId": "urn:uuid:provider:transfer-1",
    "dataPlaneId": "urn:uuid:dp-1",
    "datasetId": "urn:uuid:dataset-1",
    "state": "STARTED",
    "dataAddress": {
    "@type": "DataAddress",
    "endpointType": "string",
    "endpoint": "string",
    "endpointProperties": [
    {
    "@type": "EndpointProperty",
    "name": "string",
    "value": "string"
    }
    ]
    }
    }