http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityDefinition.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityDefinition.html b/content/0.6-incubating/restapi/EntityDefinition.html new file mode 100644 index 0000000..a1053ca --- /dev/null +++ b/content/0.6-incubating/restapi/EntityDefinition.html @@ -0,0 +1,159 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/definition/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </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></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 + +</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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityDelete.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityDelete.html b/content/0.6-incubating/restapi/EntityDelete.html new file mode 100644 index 0000000..84d1eec --- /dev/null +++ b/content/0.6-incubating/restapi/EntityDelete.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - DELETE /api/entities/delete/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">DELETE /api/entities/delete/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>DELETE /api/entities/delete/:entity-type/:entity-name<a name="DELETE_apientitiesdelete:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Delete the specified entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be feed or process.</li> +<li>:entity-name is name of the feed or process.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the delete operation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n", + "message": "falcon\/SampleProcess(cluster) removed successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityDependencies.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityDependencies.html b/content/0.6-incubating/restapi/EntityDependencies.html new file mode 100644 index 0000000..6972367 --- /dev/null +++ b/content/0.6-incubating/restapi/EntityDependencies.html @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/dependencies/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/dependencies/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/dependencies/:entity-type/:entity-name<a name="GET_apientitiesdependencies:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get dependencies of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Dependenciess of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/dependencies/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name": "SampleInput", + "type": "feed", + "tag": [Input] + }, + { + "name": "SampleOutput", + "type": "feed" + "tag": [Output] + }, + { + "name": "primary-cluster", + "type": "cluster" + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityList.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityList.html b/content/0.6-incubating/restapi/EntityList.html new file mode 100644 index 0000000..ca7a299 --- /dev/null +++ b/content/0.6-incubating/restapi/EntityList.html @@ -0,0 +1,216 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/list/:entity-type?fields=:fields</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/list/:entity-type?fields=:fields</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/list/:entity-type?fields=:fields<a name="GET_apientitieslist:entity-typefields:fields"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get list of the entities.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type 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: [email protected],[email protected]</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> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/list/feed + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name": "SampleOutput", + "type": "feed" + }, + { + "name": "SampleInput", + "type": "feed" + } + ] +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/list/feed?fields=status + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name" : "SampleOutput", + "type" : "feed", + "status": "RUNNING" + }, + { + "name": "SampleInput", + "type": "feed", + "status": "RUNNING" + } + ] +} + +</pre></div></div> +<div 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&[email protected]&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": "[email protected]" + }, + { + "name": "SampleProcess3", + "type": "process", + "status": "RUNNING", + "pipelines": "dataReplication", + "tags": "[email protected],[email protected]" + } + ] +} + +</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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityResume.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityResume.html b/content/0.6-incubating/restapi/EntityResume.html new file mode 100644 index 0000000..091cbc4 --- /dev/null +++ b/content/0.6-incubating/restapi/EntityResume.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/resume/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/resume/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/resume/:entity-type/:entity-name<a name="POST_apientitiesresume:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Resume a supended entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the resume command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/resume/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n", + "message": "default\/SampleProcess(process) resumed successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntitySchedule.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntitySchedule.html b/content/0.6-incubating/restapi/EntitySchedule.html new file mode 100644 index 0000000..dcf3fd5 --- /dev/null +++ b/content/0.6-incubating/restapi/EntitySchedule.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/schedule/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/schedule/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/schedule/:entity-type/:entity-name<a name="POST_apientitiesschedule:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Schedule an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the schedule command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/schedule/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n", + "message": "default\/SampleProcess(process) scheduled successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityStatus.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityStatus.html b/content/0.6-incubating/restapi/EntityStatus.html new file mode 100644 index 0000000..4f58a39 --- /dev/null +++ b/content/0.6-incubating/restapi/EntityStatus.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/status/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/status/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/status/:entity-type/:entity-name<a name="GET_apientitiesstatus:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get status of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/status/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n", + "message": "default\/SUBMITTED\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntitySubmit.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntitySubmit.html b/content/0.6-incubating/restapi/EntitySubmit.html new file mode 100644 index 0000000..754826c --- /dev/null +++ b/content/0.6-incubating/restapi/EntitySubmit.html @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST api/entities/submit/:entity-type</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/entities/submit/:entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/entities/submit/:entity-type<a name="POST__apientitiessubmit:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Submit the given entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>:entity-type can be cluster, feed or process.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the submission.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submit/feed +<?xml version="1.0" encoding="UTF-8"?> +<!-- Hourly sample input data --> + +<feed description="sample input data" + name="SampleInput" xmlns="uri:falcon:feed:0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <groups>group</groups> + <frequency>hours(1)</frequency> + <late-arrival cut-off="hours(6)" /> + <clusters> + <cluster name="primary-cluster" type="source"> + <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /--> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" /> + <retention limit="months(24)" action="delete" /> + </cluster> + </clusters> + + <locations> + <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" /> + <location type="stats" path="/projects/bootcamp/stats/SampleInput" /> + <location type="meta" path="/projects/bootcamp/meta/SampleInput" /> + </locations> + + <ACL owner="suser" group="users" permission="0755" /> + + <schema location="/none" provider="none" /> +</feed> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n", + "message": "default\/Submit successful (feed) SampleInput\n", + "status": "SUCCEEDED" +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submit/process +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n", + "message": "default\/Submit successful (process) SampleProcess\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntitySubmitAndSchedule.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntitySubmitAndSchedule.html b/content/0.6-incubating/restapi/EntitySubmitAndSchedule.html new file mode 100644 index 0000000..939bcef --- /dev/null +++ b/content/0.6-incubating/restapi/EntitySubmitAndSchedule.html @@ -0,0 +1,169 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/submitAndSchedule/:entity-type</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/submitAndSchedule/:entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/submitAndSchedule/:entity-type<a name="POST_apientitiessubmitAndSchedule:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Submits and schedules an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the submit and schedule command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submitAndSchedule/process +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "schedule\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\nsubmit\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\n", + "message": "schedule\/default\/SampleProcess(process) scheduled successfully\n\nsubmit\/default\/Submit successful (process) SampleProcess\n\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntitySummary.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntitySummary.html b/content/0.6-incubating/restapi/EntitySummary.html new file mode 100644 index 0000000..44b09d6 --- /dev/null +++ b/content/0.6-incubating/restapi/EntitySummary.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/summary/:entity-type</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/summary/:entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/summary/:entity-type<a name="GET_apientitiessummary:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>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 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: [email protected],[email protected]</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?cluster=primary-cluster&filterBy=STATUS:RUNNING&fields=status&[email protected]&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-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntitySuspend.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntitySuspend.html b/content/0.6-incubating/restapi/EntitySuspend.html new file mode 100644 index 0000000..ea7aaea --- /dev/null +++ b/content/0.6-incubating/restapi/EntitySuspend.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/suspend/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/suspend/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/suspend/:entity-type/:entity-name<a name="POST_apientitiessuspend:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Suspend an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/suspend/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n", + "message": "default\/SampleProcess(process) suspended successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.6-incubating/restapi/EntityUpdate.html ---------------------------------------------------------------------- diff --git a/content/0.6-incubating/restapi/EntityUpdate.html b/content/0.6-incubating/restapi/EntityUpdate.html new file mode 100644 index 0000000..c7b0982 --- /dev/null +++ b/content/0.6-incubating/restapi/EntityUpdate.html @@ -0,0 +1,171 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST api/entities/update/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/entities/update/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.6-release-notes"; class="externalLink" title="Released: 2014-12-05"> + Released: 2014-12-05</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon"; class="externalLink" title="0.6-incubating"> + 0.6-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/entities/update/:entity-type/:entity-name<a name="POST__apientitiesupdate:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Updates the submitted entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be feed or process.</li> +<li>:entity-name is name of the feed or process.</li> +<li>:effective is optional effective time</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the validation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/update/process/SampleProcess?effective=2014-01-01T00:00Z +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n", + "message": "update\/default\/SampleProcess updated successfully with effective time [(local/2014-01-01T00:00Z)]\n\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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>
