ジャンプ先

• リクエスト
• レスポンス

GGSAパイプラインのパブリッシュ

patch

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

GGSAパイプラインのパブリッシュ

リクエスト

パス・パラメータ

• id(required): string
  パイプラインID
• version(required): string
  GGSA APIバージョン

  例:

  v1

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

パイプラインのランタイム・パラメータ。

ルート・スキーマ: schema

タイプ: object

ソースの表示

• batchDuration: integer (int64)
  デフォルト値: 1000

  パイプラインのストリーミング・ジョブのバッチ期間(ミリ秒)。
• driverCores: integer (int32)
  最小値: 1

  デフォルト値: 1

  パイプライン実行のドライバ当たりのコア数。
• driverMemory: integer (int64)
  最小値: 800

  デフォルト値: 1800

  パイプライン実行のドライバ・インスタンス当たりのメモリー。
• enableCheckPointing: boolean
  パイプラインのHAのオン/オフを切り替えます。
• enableIntermediateTopic: boolean
  パイプライン中間トピック設定。
• exectorCores: integer (int32)
  最小値: 2

  デフォルト値: 2

  パイプライン実行のエグゼキュータ当たりのコア数。
• executorInstance: integer (int32)
  最小値: 1

  パイプライン実行のエグゼキュータ数。
• executorMemory: integer (int64)
  最小値: 800

  デフォルト値: 1500

  パイプライン実行のエグゼキュータ・インスタンス当たりのメモリー。
• intermediateTopicRetentionPeriod: integer (int64)
  デフォルト値: 3600000

  パイプライン・トピック保持期間(ミリ秒)。
• logLevel: string
  デフォルト値: Info

  指定できる値: [ "Debug, Info, Warning, Error" ]

  パイプライン実行ログのロギング・レベル。
• resetOffset: boolean
  デフォルト値: false

  入力トピック・オフセットのハード・リセット値。
• topicOffset: string
  デフォルト値: latest

  指定できる値: [ "latest, earliest" ]

  トピック・オフセットの位置。

{
    "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"
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

パイプラインは正常にパブリッシュされました。

本文()

ルート・スキーマ: PipelineDetail

タイプ: object

ソースの表示

• createdAt: string (date-time)
  GGSAパイプラインの作成時間。
• createdBy: string
  GGSAパイプラインの作成者。
• description: string
  GGSAパイプラインの説明。
• displayName: string
  GGSAパイプラインの表示名。
• id: string
  GGSAパイプラインID。
• name: string
  GGSAパイプライン名。
• published: boolean
  GGSAパイプラインのパブリッシュ・フラグ。
• tagNames: array tagnames
  GGSAパイプラインに定義されているタグのリスト。

{
    "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"
    }
}

ネストされたスキーマ: tagnames

タイプ: array

GGSAパイプラインに定義されているタグのリスト。

ソースの表示

• Array of: string
  GGSAパイプラインに定義されているタグのリスト。

{
    "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レスポンス

パイプラインIDが見つかりません。

409レスポンス

状態/競合が正しくありません。

先頭に戻る