http://git-wip-us.apache.org/repos/asf/falcon/blob/8609ffd6/site/0.4-incubating/docs/restapi/EntitySubmit.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/EntitySubmit.html b/site/0.4-incubating/docs/restapi/EntitySubmit.html new file mode 100644 index 0000000..f9f403d --- /dev/null +++ b/site/0.4-incubating/docs/restapi/EntitySubmit.html @@ -0,0 +1,214 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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 +Remote-User: rgautam +<?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 +Remote-User: rgautam +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/EntitySubmitAndSchedule.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/EntitySubmitAndSchedule.html b/site/0.4-incubating/docs/restapi/EntitySubmitAndSchedule.html new file mode 100644 index 0000000..246aaac --- /dev/null +++ b/site/0.4-incubating/docs/restapi/EntitySubmitAndSchedule.html @@ -0,0 +1,170 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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 +Remote-User: rgautam +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/EntitySuspend.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/EntitySuspend.html b/site/0.4-incubating/docs/restapi/EntitySuspend.html new file mode 100644 index 0000000..adbf00d --- /dev/null +++ b/site/0.4-incubating/docs/restapi/EntitySuspend.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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 +Remote-User: rgautam + +</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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/EntityUpdate.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/EntityUpdate.html b/site/0.4-incubating/docs/restapi/EntityUpdate.html new file mode 100644 index 0000000..d847c94 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/EntityUpdate.html @@ -0,0 +1,171 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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></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 +Remote-User: rgautam +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <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\n\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/EntityValidate.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/EntityValidate.html b/site/0.4-incubating/docs/restapi/EntityValidate.html new file mode 100644 index 0000000..39c2877 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/EntityValidate.html @@ -0,0 +1,290 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="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/validate/entity-type</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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 +Remote-User: rgautam +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast"> + <interfaces> + <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="3.3.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 +Remote-User: rgautam +<?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 +Remote-User: rgautam +<?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 +Remote-User: rgautam +<?xml version="1.0" encoding="UTF-8"?> +<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --> +<process xmlns="uri:falcon:process:0.1" name="SampleProcess" > + <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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceKill.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceKill.html b/site/0.4-incubating/docs/restapi/InstanceKill.html new file mode 100644 index 0000000..aad2ea8 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceKill.html @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <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="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/instance/kill/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-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 a currently running instance.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start start time of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the kill operation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceLogs.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceLogs.html b/site/0.4-incubating/docs/restapi/InstanceLogs.html new file mode 100644 index 0000000..1498f8f --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceLogs.html @@ -0,0 +1,156 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/logs/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <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/instance/logs/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/logs/:entity-type/:entity-name<a name="GET_apiinstancelogs:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get log of a specific instance of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instace that you want to refer to</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Log of specified instance.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "actions": [ + { + "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log", + "status": "SUCCEEDED", + "action": "pig" + } + ], + "details": "", + "endTime": "2013-10-21T14:40:26-07:00", + "startTime": "2013-10-21T14:39:56-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log", + "status": "SUCCEEDED", + "instance": "2012-04-03T07:00Z" + } + ], + "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-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceRerun.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceRerun.html b/site/0.4-incubating/docs/restapi/InstanceRerun.html new file mode 100644 index 0000000..5a6340a --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceRerun.html @@ -0,0 +1,148 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/instance/rerun/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <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/instance/rerun/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/instance/rerun/:entity-type/:entity-name<a name="POST_apiinstancererun:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Rerun a specific instance of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instance that you want to refer to</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the rerun command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:10:47-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n", + "message": "default\/RERUN\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceResume.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceResume.html b/site/0.4-incubating/docs/restapi/InstanceResume.html new file mode 100644 index 0000000..cdfafc2 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceResume.html @@ -0,0 +1,148 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/instance/resume/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <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/instance/resume/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/instance/resume/:entity-type/:entity-name<a name="POST_apiinstanceresume:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Resume a specific instance of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instance that you want to refer to</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the resume command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:19:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n", + "message": "default\/RESUME\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceRunning.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceRunning.html b/site/0.4-incubating/docs/restapi/InstanceRunning.html new file mode 100644 index 0000000..cf749f1 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceRunning.html @@ -0,0 +1,145 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/running/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <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/instance/running/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/running/:entity-type/:entity-name<a name="GET_apiinstancerunning:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get a list of instances currently running for a given entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>List of instances currently running.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=* +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "startTime": "2013-10-21T14:39:28-07:00", + "cluster": "primary-cluster", + "status": "RUNNING", + "instance": "2012-04-03T06:00Z" + } + ], + "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n", + "message": "default\/Running Instances\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceStatus.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceStatus.html b/site/0.4-incubating/docs/restapi/InstanceStatus.html new file mode 100644 index 0000000..1e7c159 --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceStatus.html @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/status/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <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/instance/status/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/status/:entity-type/:entity-name<a name="GET_apiinstancestatus:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get status of a specific instance of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instance that you want to refer to</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the specified instance.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "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> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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/8609ffd6/site/0.4-incubating/docs/restapi/InstanceSuspend.html ---------------------------------------------------------------------- diff --git a/site/0.4-incubating/docs/restapi/InstanceSuspend.html b/site/0.4-incubating/docs/restapi/InstanceSuspend.html new file mode 100644 index 0000000..51052cd --- /dev/null +++ b/site/0.4-incubating/docs/restapi/InstanceSuspend.html @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2015-11-30 + | 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="20151130" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/instance/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/instance/suspend/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</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.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/instance/suspend/:entity-type/:entity-name<a name="POST_apiinstancesuspend: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 a specific instance of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li> +<li>start is the start time of the instance that you want to refer to</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the suspend command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T15:15:01-07:00", + "startTime": "2013-10-21T15:14:32-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\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n", + "message": "default\/SUSPEND\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2015 + <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>
