Jump to

• Request
• Response

Publish a GGSA pipeline

patch

https://{ggsa_host}:{ggsa_port}/{context_path}/services/{version}/pipelines/{id}/publish

Publish a GGSA pipeline

Request

Path Parameters

• id(required): string
  Pipeline id
• version(required): string
  GGSA API version

  Example:

  v1

Supported Media Types

• application/json

Request Body - application/json ()

Runtime parameters for the Pipeline.

Root Schema : schema

Type: object

Show Source

• batchDuration: integer (int64)
  Default Value: 1000

  Batch duration (millisecond) of streaming job for the pipeline.
• driverCores: integer (int32)
  Minimum Value: 1

  Default Value: 1

  The number of cores per driver for the pipeline execution.
• driverMemory: integer (int64)
  Minimum Value: 800

  Default Value: 1800

  Memory per driver instance for the pipeline execution.
• enableCheckPointing: boolean
  Turns HA on/off for the pipeline.
• enableIntermediateTopic: boolean
  Pipeline Intermediate Topic Setting.
• exectorCores: integer (int32)
  Minimum Value: 2

  Default Value: 2

  The number of cores per executor for the pipeline execution.
• executorInstance: integer (int32)
  Minimum Value: 1

  The number of executors for the pipeline execution.
• executorMemory: integer (int64)
  Minimum Value: 800

  Default Value: 1500

  Memory per executor instance for the pipeline execution.
• intermediateTopicRetentionPeriod: integer (int64)
  Default Value: 3600000

  The Pipeline Topic Retention Period (in milliseconds).
• logLevel: string
  Default Value: Info

  Allowed Values: [ "Debug, Info, Warning, Error" ]

  Logging level for pipeline execution logs.
• resetOffset: boolean
  Default Value: false

  Input topics offset hard reset value.
• topicOffset: string
  Default Value: latest

  Allowed Values: [ "latest, earliest" ]

  Topic Offset Position.

{
    "type":"object",
    "properties":{
        "batchDuration":{
            "type":"integer",
            "description":"Batch duration (millisecond) of streaming job for the pipeline.",
            "format":"int64",
            "default":1000
        },
        "logLevel":{
            "type":"string",
            "description":"Logging level for pipeline execution logs.",
            "enum":[
                "Debug, Info, Warning, Error"
            ],
            "default":"Info"
        },
        "executorInstance":{
            "minimum":1,
            "type":"integer",
            "description":"The number of executors for the pipeline execution.",
            "format":"int32"
        },
        "exectorCores":{
            "minimum":2,
            "type":"integer",
            "description":"The number of cores per executor for the pipeline execution.",
            "format":"int32",
            "default":2
        },
        "executorMemory":{
            "minimum":800,
            "type":"integer",
            "description":"Memory per executor instance for the pipeline execution.",
            "format":"int64",
            "default":1500
        },
        "driverCores":{
            "minimum":1,
            "type":"integer",
            "description":"The number of cores per driver for the pipeline execution.",
            "format":"int32",
            "default":1
        },
        "driverMemory":{
            "minimum":800,
            "type":"integer",
            "description":"Memory per driver instance for the pipeline execution.",
            "format":"int64",
            "default":1800
        },
        "enableCheckPointing":{
            "type":"boolean",
            "description":"Turns HA on/off for the pipeline."
        },
        "enableIntermediateTopic":{
            "type":"boolean",
            "description":"Pipeline Intermediate Topic Setting."
        },
        "intermediateTopicRetentionPeriod":{
            "type":"integer",
            "description":"The Pipeline Topic Retention Period (in milliseconds).",
            "format":"int64",
            "default":3600000
        },
        "topicOffset":{
            "type":"string",
            "description":"Topic Offset Position.",
            "enum":[
                "latest, earliest"
            ],
            "default":"latest"
        },
        "resetOffset":{
            "type":"boolean",
            "description":"Input topics offset hard reset value.",
            "default":false
        }
    },
    "xml":{
        "name":"PipelineConfig"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully published the pipeline.

Body ()

Root Schema : PipelineDetail

Type: object

Show Source

• createdAt: string (date-time)
  Creation time of GGSA Pipeline.
• createdBy: string
  Author of the GGSA Pipeline.
• description: string
  GGSA Pipeline Description.
• displayName: string
  GGSA Pipeline Display Name.
• id: string
  GGSA Pipeline ID.
• name: string
  GGSA Pipeline Name.
• published: boolean
  GGSA Pipeline Publish Flag.
• tagNames: array tagnames
  List of tags defined for the GGSA Pipeline.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"GGSA Pipeline ID."
        },
        "name":{
            "type":"string",
            "description":"GGSA Pipeline Name."
        },
        "displayName":{
            "type":"string",
            "description":"GGSA Pipeline Display Name."
        },
        "description":{
            "type":"string",
            "description":"GGSA Pipeline Description."
        },
        "tagNames":{
            "type":"array",
            "description":"List of tags defined for the GGSA Pipeline.",
            "xml":{
                "name":"tagnames"
            },
            "items":{
                "type":"string",
                "description":"List of tags defined for the GGSA Pipeline.",
                "xml":{
                    "name":"tagnames"
                }
            }
        },
        "createdBy":{
            "type":"string",
            "description":"Author of the GGSA Pipeline."
        },
        "createdAt":{
            "type":"string",
            "description":"Creation time of GGSA Pipeline.",
            "format":"date-time"
        },
        "published":{
            "type":"boolean",
            "description":"GGSA Pipeline Publish Flag."
        }
    },
    "xml":{
        "name":"PipelineDetail"
    }
}

Nested Schema : tagnames

Type: array

List of tags defined for the GGSA Pipeline.

Show Source

• Array of: string
  List of tags defined for the GGSA Pipeline.

{
    "type":"array",
    "description":"List of tags defined for the GGSA Pipeline.",
    "xml":{
        "name":"tagnames"
    },
    "items":{
        "type":"string",
        "description":"List of tags defined for the GGSA Pipeline.",
        "xml":{
            "name":"tagnames"
        }
    }
}

404 Response

pipeline id not found.

409 Response

Incorrect state / conflict.

Back to Top