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/02/15 06:36:58 UTC
svn commit: r1730448 [9/12] - in /falcon/site/0.9: ./ css/ falconcli/
images/ images/logos/ images/profiles/ img/ js/ restapi/
Added: falcon/site/0.9/restapi/AdjacentVertices.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AdjacentVertices.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AdjacentVertices.html (added)
+++ falcon/site/0.9/restapi/AdjacentVertices.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,199 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/lineage/vertices/:id/:direction</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/lineage/vertices/:id/:direction</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/lineage/vertices/:id/:direction<a name="GET_apimetadatalineagevertices:id:direction"></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 adjacent vertices or edges with a direction.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:id is the id of the vertex.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li>
+<li>:direction is the direction associated with the edges.</li></ul>
+<p>To get the adjacent out vertices of vertex pass direction as out, in to get adjacent in vertices and both to get both in and out adjacent vertices. Similarly to get the out edges of vertex pass outE, inE to get in edges and bothE to get the both in and out edges of vertex.</p>
+<p></p>
+<ul>
+<li>
+<ul>
+<li>out : get the adjacent out vertices of vertex</li>
+<li>in : get the adjacent in vertices of vertex</li>
+<li>both : get the both adjacent in and out vertices of vertex</li>
+<li>outCount : get the number of out vertices of vertex</li>
+<li>inCount : get the number of in vertices of vertex</li>
+<li>bothCount : get the number of adjacent in and out vertices of vertex</li>
+<li>outIds : get the identifiers of out vertices of vertex</li>
+<li>inIds : get the identifiers of in vertices of vertex</li>
+<li>bothIds : get the identifiers of adjacent in and out vertices of vertex</li></ul></li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Adjacent vertices of the vertex for the specified direction.</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/metadata/lineage/vertices/4/out
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleFeed",
+ "type":"feed-instance",
+ "_id":8,
+ "_type":"vertex"
+ }
+ ],
+ "totalSize":1}
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/metadata/lineage/vertices/4/bothE
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results":[
+ {
+ "_id":"Q5V-4-5g",
+ "_type":"edge",
+ "_outV":4,
+ "_inV":8,
+ "_label":"output"
+ }
+ ],
+ "totalSize":1
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/metadata/lineage/vertices/4/bothE?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results":[
+ {
+ "_id":"Q5V-4-5g",
+ "_type":"edge",
+ "_outV":4,
+ "_inV":8,
+ "_label":"output"
+ }
+ ],
+ "totalSize":1
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/AdminConfig.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AdminConfig.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AdminConfig.html (added)
+++ falcon/site/0.9/restapi/AdminConfig.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/admin/config/:config-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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/admin/config/:config-type</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/admin/config/:config-type<a name="GET_apiadminconfig:config-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>Get configuration information of the falcon server.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:config-type can be build, deploy, startup or runtime</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Configuration information of the server.</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/admin/config/deploy
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "properties": [
+ {
+ "value": "embedded",
+ "key": "deploy.mode"
+ },
+ {
+ "value": "all",
+ "key": "domain"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/AdminStack.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AdminStack.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AdminStack.html (added)
+++ falcon/site/0.9/restapi/AdminStack.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/admin/stack</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/admin/stack</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/admin/stack<a name="GET_apiadminstack"></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 stack trace of the falcon server.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Stack trace of the server.</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/admin/stack?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+Reference Handler
+State: WAITING
+java.lang.Object.wait(Native Method)
+java.lang.Object.wait(Object.java:485)
+java.lang.ref.Reference$ReferenceHandler.run(Reference.java:116)Finalizer
+
+...
+
+State: TIMED_WAITING
+sun.misc.Unsafe.park(Native Method)
+java.util.concurrent.locks.LockSupport.parkNanos(LockSupport.java:196)
+java.util.concurrent.SynchronousQueue$TransferStack.awaitFulfill(SynchronousQueue.java:424)
+java.util.concurrent.SynchronousQueue$TransferStack.transfer(SynchronousQueue.java:323)
+java.util.concurrent.SynchronousQueue.poll(SynchronousQueue.java:874)
+java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:955)
+java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:917)
+java.lang.Thread.run(Thread.java:695)
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/AdminVersion.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AdminVersion.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AdminVersion.html (added)
+++ falcon/site/0.9/restapi/AdminVersion.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/admin/version</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/admin/version</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/admin/version<a name="GET_apiadminversion"></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 version of the falcon server.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Version of the server.</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/admin/version?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "properties":[
+ {
+ "key":"Version",
+ "value":"0.4-incubating-SNAPSHOT-rb47788d1112fcf949c22a3860934167237b395b0"
+ },
+ {
+ "key":"Mode",
+ "value":"embedded"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/AllEdges.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AllEdges.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AllEdges.html (added)
+++ falcon/site/0.9/restapi/AllEdges.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET pi/metadata/lineage//edges/all</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET pi/metadata/lineage//edges/all</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET pi/metadata/lineage//edges/all<a name="GET_pimetadatalineageedgesall"></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 all edges.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>All edges in lineage graph.</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/metadata/lineage/edges/all?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "_id":"Q5V-4-5g",
+ "_type":"edge",
+ "_outV":4,
+ "_inV":8,
+ "_label":"output"
+ },
+ {
+ "_id":"Q6t-c-5g",
+ "_type":"edge",
+ "_outV":12,
+ "_inV":16,
+ "_label":"output"
+ }
+ ],
+ "totalSize": 2
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/AllVertices.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/AllVertices.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/AllVertices.html (added)
+++ falcon/site/0.9/restapi/AllVertices.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/lineage/vertices/all</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/lineage/vertices/all</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/lineage/vertices/all<a name="GET_apimetadatalineageverticesall"></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 all vertices.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>All vertices in lineage graph.</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/metadata/lineage/vertices/all?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleIngestProcess\/2014-03-01T10:00Z",
+ "type":"process-instance",
+ "version":"2.0.0",
+ "_id":4,
+ "_type":"vertex"
+ },
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"rawEmailFeed\/2014-03-01T10:00Z",
+ "type":"feed-instance",
+ "_id":8,
+ "_type":"vertex"
+ }
+ ],
+ "totalSize": 2
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/Edge.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/Edge.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/Edge.html (added)
+++ falcon/site/0.9/restapi/Edge.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,132 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/lineage/edges/:id</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/lineage/edges/:id</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/lineage/edges/:id<a name="GET_apimetadatalineageedges:id"></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>Gets the edge with specified id.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:id is the unique id of the edge.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Edge with the specified id.</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/metadata/lineage/edges/Q6t-c-5g?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results":
+ {
+ "_id":"Q6t-c-5g",
+ "_type":"edge",
+ "_outV":12,
+ "_inV":16,
+ "_label":"output"
+ }
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityDefinition.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityDefinition.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityDefinition.html (added)
+++ falcon/site/0.9/restapi/EntityDefinition.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/definition/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <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>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?doAs=joe
+
+</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>
+ <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>
+ <timezone>UTC</timezone>
+ <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>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityDelete.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityDelete.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityDelete.html (added)
+++ falcon/site/0.9/restapi/EntityDelete.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">DELETE /api/entities/delete/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?doAs=joe
+
+</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-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityDependencies.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityDependencies.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityDependencies.html (added)
+++ falcon/site/0.9/restapi/EntityDependencies.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/dependencies/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?doAs=joe
+
+</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-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityLineage.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityLineage.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityLineage.html (added)
+++ falcon/site/0.9/restapi/EntityLineage.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/lineage/entities?pipeline=:pipeline</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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/lineage/entities?pipeline=:pipeline</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/lineage/entities?pipeline=:pipeline<a name="GET_apimetadatalineageentitiespipeline:pipeline"></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>It returns the graph depicting the relationship between the various processes and feeds in a given pipeline.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:pipeline is the name of the pipeline</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>It returns a json graph</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/metadata/lineage/entities?pipeline=my-pipeline&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "vertices": ["my-minutely-process", "my-hourly-process"],
+ "edges":
+ [
+ {
+ "from" : "my-minutely-process",
+ "to" : "my-hourly-process",
+ "label" : "my-minutely-feed"
+ },
+ {
+ "from" : "my-hourly-process",
+ "to" : "my-minutely-process",
+ "label" : "my-hourly-feedback"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityList.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityList.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityList.html (added)
+++ falcon/site/0.9/restapi/EntityList.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,289 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/list/:entity-type?fields=:fields</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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 Comma-separated entity types. Can be empty. Valid entity types are cluster, feed or process.</li>
+<li>fields <optional param> Fields of entity that the user wants to view, separated by commas.
+<ul>
+<li>Valid options are STATUS, TAGS, PIPELINES, CLUSTERS.</li></ul></li>
+<li>nameseq <optional param> Subsequence of entity name. Not case sensitive.
+<ul>
+<li>The entity name needs to contain all the characters in the subsequence in the same order.</li>
+<li>Example 1: "sample1" will match the entity named "SampleFeed1-2".</li>
+<li>Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".</li></ul></li>
+<li>tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive.
+<ul>
+<li>The returned entities will have tags that match all the tag keywords.</li></ul></li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,PIPELINES:clickLogs
+<ul>
+<li>Supported filter fields are NAME, STATUS, PIPELINES, CLUSTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>tags <optional param> Return list of entities that have specified tags, separated by a comma. Query will do AND on tag values.
+<ul>
+<li>Example: tags=consumer=consumer@xyz.com,owner=producer@xyz.com</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "name".</li></ul></li>
+<li>sortOrder <optional param> Valid options are "asc" and "desc"</li>
+<li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li>
+<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li>
+<li>Note:
+<ul>
+<li>We have two filtering parameters for entity tags: "tags" and "tagkeys". "tags" does the exact match in key=value fashion, while "tagkeys" finds all the entities with the given key as a substring in the tags. This "tagkeys" filter is introduced for the user who doesn't remember the exact tag but some keywords in the tag. It also helps users to save the time of typing long tags.</li>
+<li>The returned entities will match all the filtering criteria.</li></ul></li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Total number of results and a list of 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>
+{
+ "totalResults":"2”,
+ "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
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "totalResults":"4”,
+ "entity": [
+ {
+ "name" : "SampleCluster1",
+ "type" : "cluster"
+ }
+ {
+ "name" : "SampleOutput",
+ "type" : "feed"
+ },
+ {
+ "name" : "SampleInput",
+ "type" : "feed"
+ }
+ {
+ "name" : "SampleProcess1",
+ "type" : "process"
+ }
+ ]
+}
+
+</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>
+{
+ "totalResults":"2”,
+ "entity": [
+ {
+ "name" : "SampleOutput",
+ "type" : "feed",
+ "status": "RUNNING"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed",
+ "status": "RUNNING"
+ }
+ ]
+}
+
+</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/process?filterBy=STATUS:RUNNING,PIPELINES:dataReplication&fields=status,pipelines,tags&tags=consumer=consumer@xyz.com&orderBy=name&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "totalResults":"10”,
+ "entity": [
+ {
+ "name" : "SampleProcess1",
+ "type" : "process",
+ "status": "RUNNING",
+ "pipelines": "dataReplication",
+ "tags": "consumer=consumer@xyz.com"
+ },
+ {
+ "name": "SampleProcess3",
+ "type": "process",
+ "status": "RUNNING",
+ "pipelines": "dataReplication",
+ "tags": "consumer=consumer@xyz.com,owner=producer@xyz.com"
+ }
+ ]
+}
+
+</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,process?nameseq=samplebill&tagkeys=billing,healthcare&numResults=2&offset=1&fields=status,clusters,tags&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "totalResults":"4”,
+ "entity”:[
+ {
+ "type":"FEED”,
+ "name":"SampleUSHealthBill”,
+ "status":"SUBMITTED”,
+ "tags”: {"tag":["related=ushealthcare","department=billingDepartment"]},
+ "clusters": {"cluster":["SampleCluster1","primaryCluster”]}
+ },
+ {
+ "type":"PROCESS”,
+ "name":"SampleHealthBill”,
+ "status":"SUBMITTED”,
+ "tags”: {"tag":["related=healthcare","department=billingDepartment"]},
+ "clusters": {"cluster":"primaryCluster”}
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityResume.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityResume.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityResume.html (added)
+++ falcon/site/0.9/restapi/EntityResume.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/resume/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?doAs=joe
+
+</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-2016
+ <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>
Added: falcon/site/0.9/restapi/EntitySchedule.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntitySchedule.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntitySchedule.html (added)
+++ falcon/site/0.9/restapi/EntitySchedule.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/entities/schedule/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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>
+<li>skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?skipDryRun=false&doAs=joe
+
+</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-2016
+ <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>
Added: falcon/site/0.9/restapi/EntityStatus.html
URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/EntityStatus.html?rev=1730448&view=auto
==============================================================================
--- falcon/site/0.9/restapi/EntityStatus.html (added)
+++ falcon/site/0.9/restapi/EntityStatus.html Mon Feb 15 05:36:56 2016
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-02-09
+ | 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="20160209" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/status/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9</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>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</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?doAs=joe
+
+</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-2016
+ <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>