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/09/12 11:43:51 UTC
svn commit: r1624488 [4/7] - in /incubator/falcon: site/
site/0.3-incubating/ site/0.4-incubating/ site/docs/ site/docs/restapi/
trunk/ trunk/general/src/site/twiki/docs/
trunk/general/src/site/twiki/docs/restapi/
Modified: incubator/falcon/site/docs/restapi/EntityDelete.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDelete.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDelete.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDelete.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/EntityDependencies.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDependencies.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDependencies.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDependencies.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/entities/dependencies/process/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
@@ -286,11 +285,13 @@ Remote-User: rgautam
"entity": [
{
"name": "SampleInput",
- "type": "feed"
+ "type": "feed",
+ "tag": [Input]
},
{
"name": "SampleOutput",
"type": "feed"
+ "tag": [Output]
},
{
"name": "primary-cluster",
Modified: incubator/falcon/site/docs/restapi/EntityList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityList.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityList.html (original)
+++ incubator/falcon/site/docs/restapi/EntityList.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -263,8 +263,23 @@
<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>
+<li>:entity-type Valid options 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.</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></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>List of the entities.</p></div>
@@ -275,7 +290,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/entities/list/feed
-Remote-User: rgautam
</pre></div></div>
<div class="section">
@@ -301,7 +315,6 @@ Remote-User: rgautam
<div class="source">
<pre>
GET http://localhost:15000/api/entities/list/feed?fields=status
-Remote-User: rgautam
</pre></div></div>
<div class="section">
@@ -324,6 +337,37 @@ Remote-User: rgautam
}
</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>
+{
+ "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>
</div>
Modified: incubator/falcon/site/docs/restapi/EntityResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityResume.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityResume.html (original)
+++ incubator/falcon/site/docs/restapi/EntityResume.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/resume/process/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/EntitySchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySchedule.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySchedule.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/schedule/process/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/EntityStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityStatus.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityStatus.html (original)
+++ incubator/falcon/site/docs/restapi/EntityStatus.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/entities/status/process/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/EntitySubmit.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmit.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmit.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmit.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -272,7 +272,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/submit/feed
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Hourly sample input data -->
@@ -318,7 +317,6 @@ Remote-User: rgautam
<div class="source">
<pre>
POST http://localhost:15000/api/entities/submit/process
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
Modified: incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -274,7 +274,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/submitAndSchedule/process
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
Added: incubator/falcon/site/docs/restapi/EntitySummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySummary.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySummary.html (added)
+++ incubator/falcon/site/docs/restapi/EntitySummary.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,364 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | 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="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/entities/summary/:entity-type/:cluster</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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <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">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/entities/summary/:entity-type/:cluster</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/entities/summary/:entity-type/:cluster<a name="GET_apientitiessummary:entity-type:cluster"></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>Given an <a href="./EntityType.html">EntityType</a> and cluster, get list of entities along with summary of N recent instances of each entity</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:cluster Show entities that belong to this cluster.</li>
+<li>start <optional param> Show entity summaries from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - 2 days).</li></ul></li>
+<li>end <optional param> Show entity summary up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></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.</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>numInstances <optional param> Number of recent instances to show per entity. Only integers > 0 are valid, Default is 7.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Show entities along with summary of N instances for each 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/summary/feed/primary-cluster?filterBy=STATUS:RUNNING&fields=status&tags=consumer=consumer@xyz.com&orderBy=name&offset=0&numResults=1&numInstances=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "entitySummary": [
+ {
+ "name" : "SampleOutput",
+ "type" : "feed",
+ "status": "RUNNING",
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ]
+ }
+ ]
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Modified: incubator/falcon/site/docs/restapi/EntitySuspend.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySuspend.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySuspend.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySuspend.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -275,7 +275,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/suspend/process/SampleProcess
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/EntityUpdate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityUpdate.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityUpdate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityUpdate.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -276,7 +276,6 @@
<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"?>
<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
Modified: incubator/falcon/site/docs/restapi/EntityValidate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityValidate.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityValidate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityValidate.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -272,7 +272,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/cluster
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast">
<interfaces>
@@ -306,7 +305,6 @@ Remote-User: rgautam
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/feed
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Hourly sample input data -->
@@ -352,7 +350,6 @@ Remote-User: rgautam
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/feed
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Daily sample output data -->
@@ -394,7 +391,6 @@ xmlns:xsi="http://www.w3.org/2001/X
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/process
-Remote-User: rgautam
<?xml version="1.0" encoding="UTF-8"?>
<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
Added: incubator/falcon/site/docs/restapi/Graph.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/Graph.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/Graph.html (added)
+++ incubator/falcon/site/docs/restapi/Graph.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,303 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | 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="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/graphs/lineage/serialize</title>
+ <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../../css/site.css" />
+ <link rel="stylesheet" href="../../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <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">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/graphs/lineage/serialize</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/graphs/lineage/serialize<a name="GET_apigraphslineageserialize"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Dump the graph.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p>None.</p></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Serialize graph to a file configured using *.falcon.graph.serialize.path in Custom startup.properties.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/graphs/lineage/serialize
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<p>None.</p></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Modified: incubator/falcon/site/docs/restapi/InstanceKill.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceKill.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceKill.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceKill.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -265,7 +265,8 @@
<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>
+<li>start start time of the entity.</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Result of the kill operation.</p></div>
@@ -276,7 +277,6 @@
<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">
Added: incubator/falcon/site/docs/restapi/InstanceList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceList.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceList.html (added)
+++ incubator/falcon/site/docs/restapi/InstanceList.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,382 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | 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="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/list/: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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <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">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/list/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/list/:entity-type/:entity-name<a name="GET_apiinstancelist: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 list of all instances of a given entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</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></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>List of instances of given 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/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:26-07:00",
+ "startTime": "2013-10-21T14:41:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Modified: incubator/falcon/site/docs/restapi/InstanceLogs.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceLogs.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceLogs.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceLogs.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -263,10 +263,27 @@
<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>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>runId <optional param> Run Id.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</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></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Log of specified instance.</p></div>
@@ -277,7 +294,6 @@
<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">
@@ -309,6 +325,58 @@ Remote-User: rgautam
}
</pre></div></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&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ }
+ ],
+ "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
</div>
</div>
Modified: incubator/falcon/site/docs/restapi/InstanceRerun.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRerun.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRerun.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRerun.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -265,7 +265,8 @@
<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>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Results of the rerun command.</p></div>
@@ -276,7 +277,6 @@
<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">
Modified: incubator/falcon/site/docs/restapi/InstanceResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceResume.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceResume.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceResume.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -265,7 +265,8 @@
<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>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Results of the resume command.</p></div>
@@ -276,7 +277,6 @@
<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">
Modified: incubator/falcon/site/docs/restapi/InstanceRunning.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRunning.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRunning.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRunning.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| 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="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<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" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -263,8 +263,20 @@
<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>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</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></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>List of instances currently running.</p></div>
@@ -275,7 +287,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
-Remote-User: rgautam
</pre></div></div>
<div class="section">
@@ -297,6 +308,45 @@ Remote-User: rgautam
}
</pre></div></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=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
</div>
</div>