You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ba...@apache.org on 2016/08/08 23:16:09 UTC
[35/49] falcon git commit: FALCON-2006 Update documentation on site
for 0.10 release
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/EntityUpdate.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/EntityUpdate.html b/content/0.10/restapi/EntityUpdate.html
new file mode 100644
index 0000000..cc9b5bd
--- /dev/null
+++ b/content/0.10/restapi/EntityUpdate.html
@@ -0,0 +1,163 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/entities/update/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</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 cluster, feed or process.</li>
+<li>:entity-name is name of the cluster, feed or process.</li>
+<li>skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the 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?skipDryRun=false&doAs=joe
+<?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-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/EntityValidate.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/EntityValidate.html b/content/0.10/restapi/EntityValidate.html
new file mode 100644
index 0000000..685a3ec
--- /dev/null
+++ b/content/0.10/restapi/EntityValidate.html
@@ -0,0 +1,281 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <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>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/entities/validate/entity-type</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</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></p>
+<ul>
+<li>:entity-type can be cluster, feed or process.</li>
+<li>skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.</li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the 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?skipDryRun=true
+<?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?skipDryRun=false&doAs=joe
+<?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-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDefinition.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionDefinition.html b/content/0.10/restapi/ExtensionDefinition.html
new file mode 100644
index 0000000..28ce967
--- /dev/null
+++ b/content/0.10/restapi/ExtensionDefinition.html
@@ -0,0 +1,258 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/extension/definition/:extensionname</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/extension/definition/:extensionname</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/extension/definition/:extension­name<a name="GET_apiextensiondefinition:extensionname"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get definition of the extension.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:extension­name Name of the extension.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Outputs a JSON document describing the extension invocation parameters.</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/extension/definition/hdfs­mirroring
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "shortDescription": "This extension implements replicating arbitrary directories on HDFS from one Hadoop cluster to another Hadoop cluster. This piggy backs on replication solution in Falcon which uses the DistCp tool.",
+ "properties":[
+ {
+ "propertyName":"jobName",
+ "required":true,
+ "description":"Unique job name",
+ "example":"hdfs-monthly-sales-dr"
+ },
+ {
+ "propertyName":"jobClusterName",
+ "required":true,
+ "description":"Cluster where job should run",
+ "example":"backupCluster"
+ },
+ {
+ "propertyName":"jobValidityStart",
+ "required":true,
+ "description":"Job validity start time",
+ "example":"2016-03-03T00:00Z"
+ },
+ {
+ "propertyName":"jobValidityEnd",
+ "required":true,
+ "description":"Job validity end time",
+ "example":"2018-03-13T00:00Z"
+ },
+ {
+ "propertyName":"jobFrequency",
+ "required":true,
+ "description":"job frequency. Valid frequency types are minutes, hours, days, months",
+ "example":"months(1)"
+ },
+ {
+ "propertyName":"jobTimezone",
+ "required":false,
+ "description":"Time zone for the job",
+ "example":"GMT"
+ },
+ {
+ "propertyName":"jobTags",
+ "required":false,
+ "description":"list of comma separated tags. Key Value Pairs, separated by comma",
+ "example":"consumer=consumer@xyz.com, owner=producer@xyz.com, _department_type=forecasting"
+ },
+ {
+ "propertyName":"jobRetryPolicy",
+ "required":false,
+ "description":"Job retry policy",
+ "example":"periodic"
+ },
+ {
+ "propertyName":"jobRetryDelay",
+ "required":false,
+ "description":"Job retry delay",
+ "example":"minutes(30)"
+ },
+ {
+ "propertyName":"jobRetryAttempts",
+ "required":false,
+ "description":"Job retry attempts",
+ "example":"3"
+ },
+ {
+ "propertyName":"jobRetryOnTimeout",
+ "required":false,
+ "description":"Job retry on timeout",
+ "example":"true"
+ },
+ {
+ "propertyName":"jobAclOwner",
+ "required":false,
+ "description":"ACL owner",
+ "example":"ambari-qa"
+ },
+ {
+ "propertyName":"jobAclGroup",
+ "required":false,
+ "description":"ACL group",
+ "example":"users"
+ },
+ {
+ "propertyName":"jobAclPermission",
+ "required":false,
+ "description":"ACL permission",
+ "example":"0x755"
+ },
+ {
+ "propertyName":"sourceDir",
+ "required":true,
+ "description":"Multiple hdfs comma separated source directories",
+ "example":"/user/ambari-qa/primaryCluster/dr/input1, /user/ambari-qa/primaryCluster/dr/input2"
+ },
+ {
+ "propertyName":"sourceCluster",
+ "required":true,
+ "description":"Source cluster for hdfs mirroring",
+ "example":"primaryCluster"
+ },
+ {
+ "propertyName":"targetDir",
+ "required":true,
+ "description":"Target hdfs directory",
+ "example":"/user/ambari-qa/backupCluster/dr"
+ },
+ {
+ "propertyName":"targetCluster",
+ "required":true,
+ "description":"Target cluster for hdfs mirroring",
+ "example":"backupCluster"
+ },
+ {
+ "propertyName":"distcpMaxMaps",
+ "required":false,
+ "description":"Maximum number of mappers for DistCP",
+ "example":"1"
+ },
+ {
+ "propertyName":"distcpMapBandwidth",
+ "required":false,
+ "description":"Bandwidth in MB for each mapper in DistCP",
+ "example":"100"
+ },
+ {
+ "propertyName":"jobNotificationType",
+ "required":false,
+ "description":"Email Notification for Falcon instance completion",
+ "example":"email"
+ },
+ {
+ "propertyName":"jobNotificationReceivers",
+ "required":false,
+ "description":"Comma separated email Id's",
+ "example":"user1@gmail.com, user2@gmail.com"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDelete.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionDelete.html b/content/0.10/restapi/ExtensionDelete.html
new file mode 100644
index 0000000..5c6cb22
--- /dev/null
+++ b/content/0.10/restapi/ExtensionDelete.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/delete/:job-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/delete/:job-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/delete/:job-name<a name="POST_apiextensiondelete:job-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Delete an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:job-name Name of the extension job.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the delete operation.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+POST http://localhost:15000/api/extensions/delete/sales-monthly
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job sales-monthly deleted successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDescription.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionDescription.html b/content/0.10/restapi/ExtensionDescription.html
new file mode 100644
index 0000000..a8013a3
--- /dev/null
+++ b/content/0.10/restapi/ExtensionDescription.html
@@ -0,0 +1,122 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/extension/describe/:extensionname</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/extension/describe/:extensionname</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/extension/describe/:extension­name<a name="GET_apiextensiondescribe:extensionname"></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>Description of an extension.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:extension­name Name of the extension.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Outputs the README of the specified extension.</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/extension/describe/hdfs­mirroring
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+<README file of the specified extension>
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionEnumeration.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionEnumeration.html b/content/0.10/restapi/ExtensionEnumeration.html
new file mode 100644
index 0000000..278f7b0
--- /dev/null
+++ b/content/0.10/restapi/ExtensionEnumeration.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/extension/enumerate</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/extension/enumerate</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/extension/enumerate<a name="GET_apiextensionenumerate"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get list of the supported extensions.</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>Total number of results and a list of extension server extensions supported.</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/extension/enumerate
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "totalResults":"2”,
+ “extensions”: [
+ {
+ “name”: “Hdfs­mirroring”
+ “type”: “Trusted/Provided extension”
+ “description”: “This extension implements replicating arbitrary directories on HDFS from one Hadoop cluster to another Hadoop cluster.”
+ },
+ {
+ “name”: “Hive­mirroring”
+ “type”: “Trusted/Provided extension”
+ “description”: “This extension implements replicating hive metadata and data from one Hadoop cluster to another Hadoop cluster.”
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionInstances.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionInstances.html b/content/0.10/restapi/ExtensionInstances.html
new file mode 100644
index 0000000..616e6ff
--- /dev/null
+++ b/content/0.10/restapi/ExtensionInstances.html
@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/extension/instances/:job-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/extension/instances/:job-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/extension/instances/:job-name<a name="GET_apiextensioninstances:job-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>List instances of an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:job-name Name of the extension job.</li>
+<li>start <optional> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.</li>
+<li>end <optional> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.</li>
+<li>instanceStatus <optional> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.</li>
+<li>fields <optional> Entity output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.</li>
+<li>orderBy <optional> Column by which results should be ordered. Sorted by descending order. Valid options are nominalTime (default) and status.</li>
+<li>sortOrder <optional> Valid options are “asc” and “desc”.</li>
+<li>offset <optional> Show results from the offset. Used for pagination. Default is 0.</li>
+<li>numResults <optional> Number of instances per entity to show. Default value is 10.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>A list of entities of the job, each followed by a set of instances.</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/extensions/instances/daily-health-bill?start=2012-04-01T00:00
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "numEntities": "2",
+ "entitiesSummary": {
+ "entitySummary": [
+ {
+ "entityProfile": {
+ "type": "FEED",
+ "name": "SampleUSHealthBill"
+ },
+ "instances": [
+ {
+ "instance": "2012-04-02T00:00Z",
+ "status": "RUNNING",
+ "cluster": "SampleCluster1",
+ "sourceCluster": "primaryCluster",
+ "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-02"
+ },
+ {
+ "instance": "2012-04-01T00:00Z",
+ "status": "SUCCEEDED",
+ "cluster": "SampleCluster1",
+ "sourceCluster": "primaryCluster",
+ "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-01"
+ }
+ ]
+ },
+ {
+ "entityProfile": {
+ "type": "PROCESS",
+ "name": "SampleBillPay"
+ },
+ "instances": [
+ {
+ "instance": "2012-04-02T00:00Z",
+ "status": "RUNNING",
+ "logFile": "http://sandbox.hortonworks.com:11000/oozie?job=0000085-160322203213815-oozie-oozi-W",
+ "cluster": "primaryCluster",
+ "startTime": "2016-04-04T22:37:46Z",
+ "details": "",
+ "actions": {
+ "action": "dr-replication",
+ "status": "RUNNING",
+ "logFile": "http://sandbox.hortonworks.com:8088/proxy/application_1458678764964_0052/"
+ }
+ },
+ {
+ "instance": "2012-04-01T00:00Z",
+ "status": "SKIPPED",
+ "cluster": "primaryCluster"
+ }
+ ]
+ }
+ ]
+ }
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionList.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionList.html b/content/0.10/restapi/ExtensionList.html
new file mode 100644
index 0000000..990372c
--- /dev/null
+++ b/content/0.10/restapi/ExtensionList.html
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/extension/list/:extension-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/extension/list/:extension-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/extension/list/:extension-name<a name="GET_apiextensionlist:extension-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>List jobs generated from an extension.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:extension-name Name of the extension.</li>
+<li>sortOrder <optional> Sort order by job name. Valid options: "asc" (default) and "desc".</li>
+<li>offset <optional> Show results from the offset. Default is 0.</li>
+<li>numResults <optional> Number of results to show per request. Default is 10.</li>
+<li>fields <optional> Output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Total number of results and a list of jobs generated from the extension, followed by the associated entities.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/extensions/list/billCollection?fields=status,clusters,tags
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "numJobs":"2",
+ "jobs":{
+ "job": [
+ {
+ "jobName": "daily-health-bill",
+ "jobEntities: {
+ "totalResults": "2",
+ "entity": [
+ {
+ "type":"FEED",
+ "name":"SampleUSHealthBill",
+ "status":"SUBMITTED”,
+ "tags":{"tag":["related=ushealthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
+ "clusters": {"cluster":["SampleCluster1","primaryCluster”]}
+ },
+ {
+ "type":"PROCESS”,
+ "name":"SampleBillPay”,
+ "status":"RUNNING”,
+ "tags":{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
+ "clusters":{"cluster":"primaryCluster”}
+ }
+ ]
+ }
+ },
+ {
+ "jobName": "fsa-bill",
+ "jobEntities": {
+ "totalResults": "1",
+ "entity":
+ {
+ "type":"PROCESS”,
+ "name":"FSAPay”,
+ "status":"RUNNING”,
+ "tags”:{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCollection","_falcon_extension_job=fsa-bill"]},
+ "clusters":{"cluster":"primaryCluster”}
+ }
+ }
+ }
+ ]
+ }
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionResume.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionResume.html b/content/0.10/restapi/ExtensionResume.html
new file mode 100644
index 0000000..9b5b6b0
--- /dev/null
+++ b/content/0.10/restapi/ExtensionResume.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/resume/:job-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/resume/:job-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/resume/:job-name<a name="POST_apiextensionresume:job-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 an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:job-name Name of the extension job.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the resume 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/extensions/resume/sales-monthly
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job sales-monthly resumed successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSchedule.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionSchedule.html b/content/0.10/restapi/ExtensionSchedule.html
new file mode 100644
index 0000000..4edb98d
--- /dev/null
+++ b/content/0.10/restapi/ExtensionSchedule.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/schedule/:job-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/schedule/:job-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/schedule/:job-name<a name="POST_apiextensionschedule:job-name"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Schedule an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:job-name Name of the extension job.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the schedule 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/extensions/schedule/sales-monthly
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job sales-monthly scheduled successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSubmit.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionSubmit.html b/content/0.10/restapi/ExtensionSubmit.html
new file mode 100644
index 0000000..5da5ce5
--- /dev/null
+++ b/content/0.10/restapi/ExtensionSubmit.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/submit/:extension-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/submit/:extension-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/submit/:extension-name<a name="POST_apiextensionsubmit:extension-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>Submit an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:extension-name Name of the extension.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of 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/extensions/submit/hdfs-mirroring
+jobName=sales-monthly
+jobClustername=primaryCluster
+jobClusterValidityStart=2015-03-13T00:00Z
+jobClusterValidityEnd=2016-12-30T00:00Z
+jobFrequency=minutes(5)
+sourceDir=/user/hrt_qa/dr/test/primaryCluster/input
+sourceCluster=primaryCluster
+targetDir=/user/hrt_qa/dr/test/backupCluster/input
+targetCluster=backupCluster
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job submitted successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSubmitAndSchedule.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionSubmitAndSchedule.html b/content/0.10/restapi/ExtensionSubmitAndSchedule.html
new file mode 100644
index 0000000..3e0eb91
--- /dev/null
+++ b/content/0.10/restapi/ExtensionSubmitAndSchedule.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/submitAndSchedule/:extension-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/submitAndSchedule/:extension-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/submitAndSchedule/:extension-name<a name="POST_apiextensionsubmitAndSchedule:extension-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>Submit and schedule an extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:extension-name Name of the extension.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the submit and schedule 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/extensions/submitAndSchedule/hdfs-mirroring
+jobName=sales-monthly
+jobClustername=primaryCluster
+jobClusterValidityStart=2015-03-13T00:00Z
+jobClusterValidityEnd=2016-12-30T00:00Z
+jobFrequency=minutes(5)
+sourceDir=/user/hrt_qa/dr/test/primaryCluster/input
+sourceCluster=primaryCluster
+targetDir=/user/hrt_qa/dr/test/backupCluster/input
+targetCluster=backupCluster
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job submitted and scheduled successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSuspend.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ExtensionSuspend.html b/content/0.10/restapi/ExtensionSuspend.html
new file mode 100644
index 0000000..beb811f
--- /dev/null
+++ b/content/0.10/restapi/ExtensionSuspend.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST api/extension/suspend/:job-name</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST api/extension/suspend/:job-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST api/extension/suspend/:job-name<a name="POST_apiextensionsuspend:job-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 extension job.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:job-name Name of the extension job.</li>
+<li>doAs <optional> Impersonate the user.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Result of the suspend 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/extensions/suspend/sales-monthly
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+ "message": "Extension job sales-monthly suspended successfully",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>