You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by pa...@apache.org on 2016/03/01 08:22:30 UTC
[27/51] [partial] falcon git commit: Copying over falcon site related
files to git asf-site
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityDelete.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityDelete.html b/site/0.5-incubating/restapi/EntityDelete.html
new file mode 100644
index 0000000..1e7f753
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityDelete.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - DELETE /api/entities/delete/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">DELETE /api/entities/delete/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>DELETE /api/entities/delete/:entity-type/:entity-name<a name="DELETE_apientitiesdelete:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Delete the specified entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can be feed or process.</li>
+<li>:entity-name is name of the feed or process.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Results of the delete operation.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n",
+ "message": "falcon\/SampleProcess(cluster) removed successfully\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityDependencies.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityDependencies.html b/site/0.5-incubating/restapi/EntityDependencies.html
new file mode 100644
index 0000000..719ebc4
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityDependencies.html
@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/entities/dependencies/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/dependencies/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/entities/dependencies/:entity-type/:entity-name<a name="GET_apientitiesdependencies:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get dependencies of the entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can be cluster, feed or process.</li>
+<li>:entity-name is name of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Dependenciess of the entity.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/entities/dependencies/process/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "entity": [
+ {
+ "name": "SampleInput",
+ "type": "feed",
+ "tag": [Input]
+ },
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ "tag": [Output]
+ },
+ {
+ "name": "primary-cluster",
+ "type": "cluster"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityList.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityList.html b/site/0.5-incubating/restapi/EntityList.html
new file mode 100644
index 0000000..1daebfa
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityList.html
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/entities/list/:entity-type?fields=:fields</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/list/:entity-type?fields=:fields</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/entities/list/:entity-type?fields=:fields<a name="GET_apientitieslist:entity-typefields:fields"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get list of the entities.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can be cluster, feed or process.</li>
+<li>:fields (optional) additional fields that the client are interested in, separated by commas.</li></ul>Currently falcon only support status as a valid field.</div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>List of the entities.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/entities/list/feed
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "entity": [
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed"
+ }
+ ]
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/entities/list/feed?fields=status
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "entity": [
+ {
+ "name" : "SampleOutput",
+ "type" : "feed",
+ "status": "RUNNING"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed",
+ "status": "RUNNING"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityResume.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityResume.html b/site/0.5-incubating/restapi/EntityResume.html
new file mode 100644
index 0000000..8638bda
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityResume.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/entities/resume/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/resume/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/entities/resume/:entity-type/:entity-name<a name="POST_apientitiesresume:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Resume a supended entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the resume command.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/resume/process/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n",
+ "message": "default\/SampleProcess(process) resumed successfully\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntitySchedule.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntitySchedule.html b/site/0.5-incubating/restapi/EntitySchedule.html
new file mode 100644
index 0000000..69d9408
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntitySchedule.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/entities/schedule/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/schedule/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/entities/schedule/:entity-type/:entity-name<a name="POST_apientitiesschedule:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Schedule an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the schedule command.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/schedule/process/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n",
+ "message": "default\/SampleProcess(process) scheduled successfully\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityStatus.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityStatus.html b/site/0.5-incubating/restapi/EntityStatus.html
new file mode 100644
index 0000000..85ccdf3
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityStatus.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/entities/status/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/status/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/entities/status/:entity-type/:entity-name<a name="GET_apientitiesstatus:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get status of the entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can be cluster, feed or process.</li>
+<li>:entity-name is name of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Status of the entity.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/entities/status/process/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n",
+ "message": "default\/SUBMITTED\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntitySubmit.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntitySubmit.html b/site/0.5-incubating/restapi/EntitySubmit.html
new file mode 100644
index 0000000..97243aa
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntitySubmit.html
@@ -0,0 +1,212 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/entities/submit/:entity-type</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/entities/submit/:entity-type</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/entities/submit/:entity-type<a name="POST__apientitiessubmit:entity-type"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Submit the given entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p>:entity-type can be cluster, feed or process.</p></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the submission.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/submit/feed
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+ name="SampleInput" xmlns="uri:falcon:feed:0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+
+ <locations>
+ <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+ </locations>
+
+ <ACL owner="suser" group="users" permission="0755" />
+
+ <schema location="/none" provider="none" />
+</feed>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n",
+ "message": "default\/Submit successful (feed) SampleInput\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/submit/process
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n",
+ "message": "default\/Submit successful (process) SampleProcess\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntitySubmitAndSchedule.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntitySubmitAndSchedule.html b/site/0.5-incubating/restapi/EntitySubmitAndSchedule.html
new file mode 100644
index 0000000..27d831e
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntitySubmitAndSchedule.html
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/entities/submitAndSchedule/:entity-type</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/submitAndSchedule/:entity-type</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/entities/submitAndSchedule/:entity-type<a name="POST_apientitiessubmitAndSchedule:entity-type"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Submits and schedules an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the submit and schedule command.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/submitAndSchedule/process
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "schedule\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\nsubmit\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\n",
+ "message": "schedule\/default\/SampleProcess(process) scheduled successfully\n\nsubmit\/default\/Submit successful (process) SampleProcess\n\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntitySuspend.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntitySuspend.html b/site/0.5-incubating/restapi/EntitySuspend.html
new file mode 100644
index 0000000..40a8f7f
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntitySuspend.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/entities/suspend/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/suspend/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/entities/suspend/:entity-type/:entity-name<a name="POST_apientitiessuspend:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Suspend an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Status of the entity.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/suspend/process/SampleProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n",
+ "message": "default\/SampleProcess(process) suspended successfully\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityUpdate.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityUpdate.html b/site/0.5-incubating/restapi/EntityUpdate.html
new file mode 100644
index 0000000..bea854d
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityUpdate.html
@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/entities/update/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/entities/update/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/entities/update/:entity-type/:entity-name<a name="POST__apientitiesupdate:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Updates the submitted entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can be feed or process.</li>
+<li>:entity-name is name of the feed or process.</li>
+<li>:effective is optional effective time</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the validation.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/update/process/SampleProcess?effective=2014-01-01T00:00Z
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+ "message": "update\/default\/SampleProcess updated successfully with effective time [(local/2014-01-01T00:00Z)]\n\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/EntityValidate.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/EntityValidate.html b/site/0.5-incubating/restapi/EntityValidate.html
new file mode 100644
index 0000000..ec269db
--- /dev/null
+++ b/site/0.5-incubating/restapi/EntityValidate.html
@@ -0,0 +1,286 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/entities/validate/entity-type</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/entities/validate/entity-type</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/entities/validate/entity-type<a name="POST__apientitiesvalidateentity-type"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Validates the submitted entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p>:entity-type can be cluster, feed or process.</p></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the validation.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/validate/cluster
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast">
+ <interfaces>
+ <interface type="readonly" endpoint="hftp://localhost:50070" version="1.1.1"/>
+ <interface type="write" endpoint="hdfs://localhost:9000" version="1.1.1"/>
+ <interface type="execute" endpoint="localhost:9001" version="1.1.1"/>
+ <interface type="workflow" endpoint="http://localhost:11000/oozie/" version="3.3.0"/>
+ <interface type="messaging" endpoint="tcp://localhost:61616?daemon=true" version="5.4.3"/>
+ </interfaces>
+ <locations>
+ <location name="staging" path="/apps/falcon/staging"/>
+ <location name="temp" path="/tmp"/>
+ <location name="working" path="/apps/falcon/working"/>
+ </locations>
+</cluster>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10",
+ "message": "Validated successfully (CLUSTER) primary-cluster",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/validate/feed
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+ name="SampleInput" xmlns="uri:falcon:feed:0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+
+ <locations>
+ <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+ </locations>
+
+ <ACL owner="suser" group="users" permission="0755" />
+
+ <schema location="/none" provider="none" />
+</feed>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0",
+ "message": "Validated successfully (FEED) SampleInput",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/validate/feed
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample output data -->
+
+<feed description="sample output data" name="SampleOutput" xmlns="uri:falcon:feed:0.1"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+ <locations>
+ <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleOutput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleOutput" />
+ </locations>
+ <ACL owner="suser" group="users" permission="0755" />
+ <schema location="/none" provider="none" />
+</feed>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "60781732-460e-4c6c-ba86-a75fae574b05",
+ "message": "Validated successfully (FEED) SampleOutput",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/entities/validate/process
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57",
+ "message": "Validated successfully (PROCESS) SampleProcess",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/Graph.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/Graph.html b/site/0.5-incubating/restapi/Graph.html
new file mode 100644
index 0000000..a94ca95
--- /dev/null
+++ b/site/0.5-incubating/restapi/Graph.html
@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/graphs/lineage/serialize</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/graphs/lineage/serialize</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/graphs/lineage/serialize<a name="GET_apigraphslineageserialize"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Dump the graph.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p>None.</p></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Serialize graph to a file configured using *.falcon.graph.serialize.path in Custom startup.properties.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/graphs/lineage/serialize
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<p>None.</p></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.5-incubating/restapi/InstanceKill.html
----------------------------------------------------------------------
diff --git a/site/0.5-incubating/restapi/InstanceKill.html b/site/0.5-incubating/restapi/InstanceKill.html
new file mode 100644
index 0000000..0132d24
--- /dev/null
+++ b/site/0.5-incubating/restapi/InstanceKill.html
@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2015-11-30
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20151130" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/kill/:entity-type/:entity-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://falcon.incubator.apache.org/index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/kill/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/kill/:entity-type/:entity-name<a name="POST_apiinstancekill:entity-type:entity-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Kill a currently running instance.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li>
+<li>start start time of the entity.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the kill operation.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T15:26:59-07:00",
+ "startTime": "2013-10-21T15:19:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "KILLED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/23b3cfee-ee22-40c0-825d-39c322587d5f\n",
+ "message": "default\/KILL\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2015
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>