Use case

Deploy, pause, resume and undeploy use cases

Overview

The Use case API allows developers to deploy, test, validate and undeploy use case. Use case definitions provide the required binding of the stream and data transports.

For further information on the structure of the content payload refer to this documentation.

Example use case content

{
  "use case": {
    "name": "basic_twindow_analytics",
    "sources": [
      "nasdaq_quotes_stream"
    ],
    "stream name": "basic_tumbling_window_pipeline",
    "sinks": [
      "kafka_analytics_view"
    ]
  }
} 

---

Deploy use case

Deploy and start a use case processing using pre-registered components

post

/joule/management/usecase/deploy

Body

namestring

enabledbooleanrequired

streamNamestring

streamSpecificationobject

processingConstraintsobject

sourcesstring[]

referenceDataSourcesstring[]

sinksstring[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/joule/management/usecase/deploy' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"streamSpecification":{"enabled":true,"bufferSize":1,"checkPointProcessing":true,"groupbyKey":{"partitionKey":1,"keys":[null]},"streamTimeType":"INGEST_TIME","consumerQueueSize":1,"consumingFrequency":1,"publishingQueueSize":1,"publishingFrequency":1,"telemetryAuditingSpecification":{"enabled":true,"rawTelemetrySpecification":{"cloneEvents":true,"auditFrequency":1},"processedTelemetrySpecification":{"cloneEvents":true,"auditFrequency":1}},"sources":[null],"groupByAttributes":[null]},"processingConstraints":{},"sources":[null],"referenceDataSources":[null],"sinks":[null]}'

201

500

501

502

503

201

No body

Successful deployed and started use case

Get deployed use cases specification

get

/joule/management/usecase/detail

Query parameters

namestringrequired

Use case logical name.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/management/usecase/detail?name=text'

201

404

500

201

No body

Successful detail provided for use cases

List registered use cases

get

/joule/management/usecase/list

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/management/usecase/list'

201

500

201

No body

Successful list use cases

Undeploy use case

Stop and undeploy a use case from the Joule process

delete

/joule/management/usecase/undeploy

Query parameters

namestringrequired

Name of use case to unregistered

Example: quoteStream

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/joule/management/usecase/undeploy?name=quoteStream'

201

500

201

No body

Successfully unregistered use case

---

Pause use case processing

put

/joule/management/usecase/pause

Path parameters

namestringrequired

Name of use case to pause

Example: quoteStream

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/joule/management/usecase/pause'

201

500

201

No body

Successful paused stream

Resume use case processing

post

/joule/management/usecase/resume

Path parameters

namestringrequired

Nane of stream to resume processing

Example: quoteStream

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/joule/management/usecase/resume'

201

500

201

No body

Successful restarted stream processing