Added: incubator/falcon/site/0.6-incubating/restapi/EntityStatus.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntityStatus.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntityStatus.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntityStatus.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/status/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/status/:entity-type/:entity-name<a name="GET_apientitiesstatus:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get status of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/status/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n", + "message": "default\/SUBMITTED\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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>
Added: incubator/falcon/site/0.6-incubating/restapi/EntitySubmit.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntitySubmit.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntitySubmit.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntitySubmit.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/entities/submit/:entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/entities/submit/:entity-type<a name="POST__apientitiessubmit:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Submit the given entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>:entity-type can be cluster, feed or process.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the submission.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submit/feed +<?xml version="1.0" encoding="UTF-8"?> +<!-- Hourly sample input data --> + +<feed description="sample input data" + name="SampleInput" xmlns="uri:falcon:feed:0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <groups>group</groups> + <frequency>hours(1)</frequency> + <late-arrival cut-off="hours(6)" /> + <clusters> + <cluster name="primary-cluster" type="source"> + <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /--> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" /> + <retention limit="months(24)" action="delete" /> + </cluster> + </clusters> + + <locations> + <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" /> + <location type="stats" path="/projects/bootcamp/stats/SampleInput" /> + <location type="meta" path="/projects/bootcamp/meta/SampleInput" /> + </locations> + + <ACL owner="suser" group="users" permission="0755" /> + + <schema location="/none" provider="none" /> +</feed> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n", + "message": "default\/Submit successful (feed) SampleInput\n", + "status": "SUCCEEDED" +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submit/process +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n", + "message": "default\/Submit successful (process) SampleProcess\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/EntitySubmitAndSchedule.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntitySubmitAndSchedule.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntitySubmitAndSchedule.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntitySubmitAndSchedule.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,169 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/submitAndSchedule/:entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/submitAndSchedule/:entity-type<a name="POST_apientitiessubmitAndSchedule:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Submits and schedules an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the submit and schedule command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/submitAndSchedule/process +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "schedule\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\nsubmit\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\n", + "message": "schedule\/default\/SampleProcess(process) scheduled successfully\n\nsubmit\/default\/Submit successful (process) SampleProcess\n\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/EntitySummary.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntitySummary.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntitySummary.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntitySummary.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../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.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/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: tags=consumer=consu...@xyz.com,owner=produ...@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?cluster=primary-cluster&filterBy=STATUS:RUNNING&fields=status&tags=consumer=consu...@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> Added: incubator/falcon/site/0.6-incubating/restapi/EntitySuspend.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntitySuspend.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntitySuspend.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntitySuspend.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/suspend/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/suspend/:entity-type/:entity-name<a name="POST_apientitiessuspend:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Suspend an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/suspend/process/SampleProcess + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n", + "message": "default\/SampleProcess(process) suspended successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/EntityUpdate.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntityUpdate.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntityUpdate.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntityUpdate.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,171 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/entities/update/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/entities/update/:entity-type/:entity-name<a name="POST__apientitiesupdate:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Updates the submitted entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be feed or process.</li> +<li>:entity-name is name of the feed or process.</li> +<li>:effective is optional effective time</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the validation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/update/process/SampleProcess?effective=2014-01-01T00:00Z +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n", + "message": "update\/default\/SampleProcess updated successfully with effective time [(local/2014-01-01T00:00Z)]\n\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/EntityValidate.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/EntityValidate.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/EntityValidate.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/EntityValidate.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,286 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST api/entities/validate/entity-type</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/entities/validate/entity-type</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/entities/validate/entity-type<a name="POST__apientitiesvalidateentity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Validates the submitted entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>:entity-type can be cluster, feed or process.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the validation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/validate/cluster +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast"> + <interfaces> + <interface type="readonly" endpoint="hftp://localhost:50070" version="1.1.1"/> + <interface type="write" endpoint="hdfs://localhost:9000" version="1.1.1"/> + <interface type="execute" endpoint="localhost:9001" version="1.1.1"/> + <interface type="workflow" endpoint="http://localhost:11000/oozie/" version="4.0.0"/> + <interface type="messaging" endpoint="tcp://localhost:61616?daemon=true" version="5.4.3"/> + </interfaces> + <locations> + <location name="staging" path="/apps/falcon/staging"/> + <location name="temp" path="/tmp"/> + <location name="working" path="/apps/falcon/working"/> + </locations> +</cluster> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10", + "message": "Validated successfully (CLUSTER) primary-cluster", + "status": "SUCCEEDED" +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/validate/feed +<?xml version="1.0" encoding="UTF-8"?> +<!-- Hourly sample input data --> + +<feed description="sample input data" + name="SampleInput" xmlns="uri:falcon:feed:0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <groups>group</groups> + <frequency>hours(1)</frequency> + <late-arrival cut-off="hours(6)" /> + <clusters> + <cluster name="primary-cluster" type="source"> + <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /--> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" /> + <retention limit="months(24)" action="delete" /> + </cluster> + </clusters> + + <locations> + <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" /> + <location type="stats" path="/projects/bootcamp/stats/SampleInput" /> + <location type="meta" path="/projects/bootcamp/meta/SampleInput" /> + </locations> + + <ACL owner="suser" group="users" permission="0755" /> + + <schema location="/none" provider="none" /> +</feed> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0", + "message": "Validated successfully (FEED) SampleInput", + "status": "SUCCEEDED" +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/validate/feed +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample output data --> + +<feed description="sample output data" name="SampleOutput" xmlns="uri:falcon:feed:0.1" +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <groups>group</groups> + <frequency>hours(1)</frequency> + <late-arrival cut-off="hours(6)" /> + <clusters> + <cluster name="primary-cluster" type="source"> + <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /--> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" /> + <retention limit="months(24)" action="delete" /> + </cluster> + </clusters> + <locations> + <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput" /> + <location type="stats" path="/projects/bootcamp/stats/SampleOutput" /> + <location type="meta" path="/projects/bootcamp/meta/SampleOutput" /> + </locations> + <ACL owner="suser" group="users" permission="0755" /> + <schema location="/none" provider="none" /> +</feed> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "60781732-460e-4c6c-ba86-a75fae574b05", + "message": "Validated successfully (FEED) SampleOutput", + "status": "SUCCEEDED" +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/entities/validate/process +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <clusters> + <cluster name="primary-cluster"> + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" /> + </cluster> + </clusters> + + <parallel>1</parallel> + <order>FIFO</order> + <frequency>hours(1)</frequency> + + <inputs> + <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" /> + </inputs> + + <outputs> + <output name="output" feed="SampleOutput" instance="yesterday(0,0)" /> + </outputs> + + <properties> + <property name="queueName" value="default" /> + <property name="ssh.host" value="localhost" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/examples/apps/aggregator" /> + <retry policy="exp-backoff" delay="minutes(5)" attempts="3" /> + + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" /> + </late-process> +</process> + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57", + "message": "Validated successfully (PROCESS) SampleProcess", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/FeedInstanceListing.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/FeedInstanceListing.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/FeedInstanceListing.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/FeedInstanceListing.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,152 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/listing/feed/: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="../../../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/instance/listing/feed/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/listing/feed/:entity-name<a name="GET_apiinstancelistingfeed: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 falcon feed instance availability.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<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></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Feed instance availability status</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/listing/feed/SampleFeed?colo=*&start=2012-04-03T07:00Z + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "size": "450231212222", + "creationTime": "1236679827365", + "cluster": "primary-cluster", + "uri": "/data/SampleFeed/2012-04-03", + "status": "AVAILABLE", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\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> Added: incubator/falcon/site/0.6-incubating/restapi/Graph.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/Graph.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/Graph.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/Graph.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET api/metadata/lineage/serialize</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="../../../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/metadata/lineage/serialize</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET api/metadata/lineage/serialize<a name="GET_apimetadatalineageserialize"></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/metadata/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> Added: incubator/falcon/site/0.6-incubating/restapi/InstanceKill.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceKill.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/InstanceKill.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/InstanceKill.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/instance/kill/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="../../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://incubator.apache.org"; id="bannerRight"> + <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/instance/kill/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/instance/kill/:entity-type/:entity-name<a name="POST_apiinstancekill:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Kill currently running instance(s) of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instance(s) that you want to refer to</li> +<li>end is the end time of the instance(s) 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>Result of the kill operation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T15:26:59-07:00", + "startTime": "2013-10-21T15:19:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "KILLED", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/23b3cfee-ee22-40c0-825d-39c322587d5f\n", + "message": "default\/KILL\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-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> Added: incubator/falcon/site/0.6-incubating/restapi/InstanceList.html URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceList.html?rev=1643497&view=auto ============================================================================== --- incubator/falcon/site/0.6-incubating/restapi/InstanceList.html (added) +++ incubator/falcon/site/0.6-incubating/restapi/InstanceList.html Sat Dec 6 06:11:41 2014 @@ -0,0 +1,204 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2014-12-05 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20141205" /> + <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> + + + </head> + <body class="topBarDisabled"> + + + + + <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="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/list/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes"; class="externalLink" title="Released: 2014-09-22"> + Released: 2014-09-22</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.5-incubating"> + 0.5-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/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>
