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

application/json

namestring

enabled*boolean

sourcesarray of string

referenceDataSourcesarray of string

streamNamestring

sinksarray of string

streamSpecificationStreamSpecification (object)

processingConstraintsProcessingConstraints (object)

Response

201500501502503

Successful deployed and started use case

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/deploy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enabled": false
    }),
});
const data = await response.json();

Get deployed use cases specification

GET/joule/management/usecase/detail

Query parameters

Response

201404500

Successful detail provided for use cases

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/detail?name=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List registered use cases

GET/joule/management/usecase/list

Response

201500

Successful list use cases

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Undeploy use case

Stop and undeploy a use case from the Joule process

DELETE/joule/management/usecase/undeploy

Query parameters

Response

201500

Successfully unregistered use case

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/undeploy?name=quoteStream', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

---

Pause use case processing

PUT/joule/management/usecase/pause

Path parameters

name*string

Name of use case to pause

Example: "quoteStream"

Response

201500

Successful paused stream

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/pause', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Resume use case processing

POST/joule/management/usecase/resume

Path parameters

name*string

Nane of stream to resume processing

Example: "quoteStream"

Response

201500

Successful restarted stream processing

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/usecase/resume', {
    method: 'POST',
    headers: {},
});
const data = await response.json();