From 4b0ac030f678f0df629ada3a85b914cd1438d076 Mon Sep 17 00:00:00 2001 From: Yun Tang Date: Sun, 28 Apr 2019 23:12:13 +0800 Subject: [PATCH] [hotfix] regenerate rest-docs to latest code --- .../generated/rest_v1_dispatcher.html | 159 +++++++++++++++++- 1 file changed, 157 insertions(+), 2 deletions(-) diff --git a/docs/_includes/generated/rest_v1_dispatcher.html b/docs/_includes/generated/rest_v1_dispatcher.html index 36ffe51b60648..4df103d7fe15b 100644 --- a/docs/_includes/generated/rest_v1_dispatcher.html +++ b/docs/_includes/generated/rest_v1_dispatcher.html @@ -352,6 +352,96 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
/jars/:jarid/plan
Verb: GETResponse code: 200 OK
Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters
+
    +
  • jarid - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).
  • +
+
Query parameters
+
    +
  • program-args (optional): Deprecated, please use 'programArg' instead. String value that specifies the arguments for the program or plan
  • +
  • programArg (optional): Comma-separated list of program arguments.
  • +
  • entry-class (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
  • +
  • parallelism (optional): Positive integer value that specifies the desired parallelism for the job.
  • +
+
+ +
+
+            
+{
+  "type" : "object",
+  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody",
+  "properties" : {
+    "entryClass" : {
+      "type" : "string"
+    },
+    "programArgs" : {
+      "type" : "string"
+    },
+    "programArgsList" : {
+      "type" : "array",
+      "items" : {
+        "type" : "string"
+      }
+    },
+    "parallelism" : {
+      "type" : "integer"
+    },
+    "jobId" : {
+      "type" : "any"
+    }
+  }
+}            
+          
+
+
+ +
+
+            
+{
+  "type" : "object",
+  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
+  "properties" : {
+    "plan" : {
+      "type" : "any"
+    }
+  }
+}            
+          
+
+
@@ -592,7 +682,7 @@ }, "status" : { "type" : "string", - "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ] + "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ] } } } @@ -829,7 +919,7 @@ }, "state" : { "type" : "string", - "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDING", "SUSPENDED", "RECONCILING" ] + "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ] }, "start-time" : { "type" : "integer" @@ -2292,6 +2382,71 @@
+ + + + + + + + + + + + + + + + + + + + + + + + + +
/jobs/:jobid/stop-with-savepoint
Verb: POSTResponse code: 202 Accepted
Stops a job with a savepoint. Optionally, it can also emit a MAX_WATERMARK before taking the savepoint to flush out any state waiting for timers to fire.
Path parameters
+
    +
  • jobid - 32-character hexadecimal string value that identifies a job.
  • +
+
+ +
+
+            
+{
+  "type" : "object",
+  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:stop:StopWithSavepointRequestBody",
+  "properties" : {
+    "targetDirectory" : {
+      "type" : "string"
+    },
+    "endOfEventTime" : {
+      "type" : "boolean"
+    }
+  }
+}            
+          
+
+
+ +
+
+            
+{
+  "type" : "object",
+  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
+  "properties" : {
+    "request-id" : {
+      "type" : "any"
+    }
+  }
+}            
+          
+
+