v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Streaming Pipelines

Get a streaming pipeline definition

Gets a streaming pipeline definition in the account and project

get/v1/projects/{projectId}/streaming-pipelines/{streamingPipelineId}

Path parameters

projectIdstring uuid required

The ID of the project in which to read the streaming pipeline definition

streamingPipelineIdstring uuid required

The ID of the streaming pipeline definition to read

Response

Successfully retrieved the streaming pipeline definition

advancedPropertiesobject

Any additional properties for the streaming pipeline

agentIdstring uuid

The ID of the agent that will run the streaming pipeline

namestring

The name of the streaming pipeline

projectIdstring uuid

The ID of the project that contains the streaming pipeline definition

streamingPipelineIdstring uuid

The ID of the streaming pipeline definition

Example response

{
  "advancedProperties": {
    "max.batch.size": 10000
  },
  "agentId": "12345678-1234-1234-1234-123456789012",
  "name": "A Streaming Pipeline",
  "projectId": "12345678-1234-1234-1234-123456789012",
  "streamingPipelineId": "12345678-1234-1234-1234-123456789012",
  "streamingSource": {
    "connection": {
      "host": "127.0.0.1",
      "jdbcProperties": {
        "date format": "ymd"
      },
      "password": {
        "secretKey": "the-secret-key",
        "secretLocation": "the-secret-location",
        "secretName": "the-secret-name"
      },
      "port": 8471,
      "username": "db2_streaming_user"
    },
    "tables": [
      {
        "schema": "SCHEMA_A",
        "table": "TABLE_A"
      }
    ]
  },
  "streamingTarget": {
    "accountKey": {
      "secretKey": "the-secret-key",
      "secretLocation": "the-secret-location",
      "secretName": "the-secret-name"
    },
    "accountName": "abs-account-name",
    "container": "streaming-container",
    "prefix": "streaming-prefix"
  }
}