You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by sr...@apache.org on 2014/07/05 16:55:59 UTC
svn commit: r1608028 [3/4] - in /incubator/falcon: site/ site/docs/
site/docs/restapi/ site/wiki/ trunk/general/src/site/
Modified: incubator/falcon/site/docs/restapi/EntityDefinition.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDefinition.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDefinition.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDefinition.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/entities/definition/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<div id="bodyColumn" >
- <div class="section"><h3>GET /api/entities/definition/:entity-type/:entity-name<a name="GET_apientitiesdefinition: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 definition 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>Definition 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 class="prettyprint">
+ <div class="section">
+<h3>GET /api/entities/definition/:entity-type/:entity-name<a name="GET_apientitiesdefinition: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 definition 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>Definition 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/definition/process/SampleProcess
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<process name="SampleProcess" xmlns="uri:falcon:process:0.1">
<clusters>
Modified: incubator/falcon/site/docs/restapi/EntityDelete.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDelete.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDelete.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDelete.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntityDependencies.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDependencies.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDependencies.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDependencies.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"entity": [
{
Modified: incubator/falcon/site/docs/restapi/EntityList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityList.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityList.html (original)
+++ incubator/falcon/site/docs/restapi/EntityList.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 cla
ss="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"entity": [
{
@@ -263,11 +295,19 @@ Remote-User: rgautam
]
}
-</pre></div></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint">
+</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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"entity": [
{
Modified: incubator/falcon/site/docs/restapi/EntityResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityResume.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityResume.html (original)
+++ incubator/falcon/site/docs/restapi/EntityResume.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntitySchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySchedule.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySchedule.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntityStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityStatus.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityStatus.html (original)
+++ incubator/falcon/site/docs/restapi/EntityStatus.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntitySubmit.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmit.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmit.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmit.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,7 +248,29 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -276,14 +301,22 @@ Remote-User: rgautam
<schema location="/none" provider="none" />
</feed>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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 class="prettyprint">
+</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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -321,7 +354,11 @@ Remote-User: rgautam
</late-process>
</process>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,7 +248,31 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -283,7 +310,11 @@ Remote-User: rgautam
</late-process>
</process>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntitySuspend.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySuspend.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySuspend.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySuspend.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntityUpdate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityUpdate.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityUpdate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityUpdate.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,7 +248,33 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -283,7 +312,11 @@ Remote-User: rgautam
</late-process>
</process>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/EntityValidate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityValidate.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityValidate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityValidate.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,7 +248,29 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -264,14 +289,22 @@ Remote-User: rgautam
</locations>
</cluster>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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 class="prettyprint">
+</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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -302,14 +335,22 @@ Remote-User: rgautam
<schema location="/none" provider="none" />
</feed>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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 class="prettyprint">
+</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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -336,14 +377,22 @@ xmlns:xsi="http://www.w3.org/2001/X
<schema location="/none" provider="none" />
</feed>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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 class="prettyprint">
+</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
Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
@@ -381,7 +430,11 @@ Remote-User: rgautam
</late-process>
</process>
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</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",
Modified: incubator/falcon/site/docs/restapi/InstanceKill.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceKill.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceKill.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceKill.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<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" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,41 @@
<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 class="prettyprint">
+ <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
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceLogs.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceLogs.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceLogs.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceLogs.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/logs/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,42 @@
<div id="bodyColumn" >
- <div class="section"><h3>GET /api/instance/logs/:entity-type/:entity-name<a name="GET_apiinstancelogs: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 log of a specific instance of 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><li>start is the start time of the instance that you want to refer to</li><li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Log of specified instance.</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 class="prettyprint">
+ <div class="section">
+<h3>GET /api/instance/logs/:entity-type/:entity-name<a name="GET_apiinstancelogs: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 log of a specific instance of 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>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Log of specified instance.</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/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceRerun.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRerun.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRerun.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRerun.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - POST /api/instance/rerun/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,41 @@
<div id="bodyColumn" >
- <div class="section"><h3>POST /api/instance/rerun/:entity-type/:entity-name<a name="POST_apiinstancererun: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>Rerun a specific instance of 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><li>start is the start time of the instance that you want to refer to</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Results of the rerun 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 class="prettypr
int">
+ <div class="section">
+<h3>POST /api/instance/rerun/:entity-type/:entity-name<a name="POST_apiinstancererun: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>Rerun a specific instance of 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>
+<li>start is the start time of the instance that you want to refer to</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Results of the rerun 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/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceResume.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceResume.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceResume.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - POST /api/instance/resume/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,41 @@
<div id="bodyColumn" >
- <div class="section"><h3>POST /api/instance/resume/:entity-type/:entity-name<a name="POST_apiinstanceresume: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 specific instance of 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><li>start is the start time of the instance that you want to refer to</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Results 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 class="pret
typrint">
+ <div class="section">
+<h3>POST /api/instance/resume/:entity-type/:entity-name<a name="POST_apiinstanceresume: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 specific instance of 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>
+<li>start is the start time of the instance that you want to refer to</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Results 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/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceRunning.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRunning.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRunning.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRunning.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/running/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,40 @@
<div id="bodyColumn" >
- <div class="section"><h3>GET /api/instance/running/:entity-type/:entity-name<a name="GET_apiinstancerunning: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 a list of instances currently running for a given 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>List of instances currently running.</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 class="prettyprint">
+ <div class="section">
+<h3>GET /api/instance/running/:entity-type/:entity-name<a name="GET_apiinstancerunning: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 a list of instances currently running for a given 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>List of instances currently running.</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/instance/running/process/SampleProcess?colo=*
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceStatus.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceStatus.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceStatus.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/status/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,42 @@
<div id="bodyColumn" >
- <div class="section"><h3>GET /api/instance/status/:entity-type/:entity-name<a name="GET_apiinstancestatus: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 a specific instance of 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><li>start is the start time of the instance that you want to refer to</li><li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Status of the specified instance.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></di
v><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint">
+ <div class="section">
+<h3>GET /api/instance/status/:entity-type/:entity-name<a name="GET_apiinstancestatus: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 a specific instance of 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>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Status of the specified instance.</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/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
Remote-User: rgautam
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"instances": [
{
Modified: incubator/falcon/site/docs/restapi/InstanceSummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceSummary.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceSummary.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceSummary.html Sat Jul 5 14:55:57 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at Feb 6, 2014
+ | Generated by Apache Maven Doxia at 2014-07-05
| 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="20140206" />
+ <meta name="Date-Revision-yyyymmdd" content="20140705" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/summary/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -153,6 +153,9 @@
<li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
</ul>
</li>
<li class="dropdown">
@@ -236,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-02-06</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
</ul>
</div>
@@ -245,11 +248,42 @@
<div id="bodyColumn" >
- <div class="section"><h3>GET /api/instance/summary/:entity-type/:entity-name<a name="GET_apiinstancesummary: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 summary of instance/instances of 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><li>start is the start time of the instance that you want to refer to</li><li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Summary of the instances over the specified time range</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 class="prettyprint">
+ <div class="section">
+<h3>GET /api/instance/summary/:entity-type/:entity-name<a name="GET_apiinstancesummary: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 summary of instance/instances of 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>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Summary of the instances over the specified time range</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/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
Remote-User: suhas
-</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint">
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
{
"status":"SUCCEEDED",
"message":"default/SUMMARY\n",