http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/EntityValidate.html ---------------------------------------------------------------------- diff --git a/content/restapi/EntityValidate.html b/content/restapi/EntityValidate.html index 4cbded6..3b6756a 100644 --- a/content/restapi/EntityValidate.html +++ b/content/restapi/EntityValidate.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <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" /> @@ -30,7 +30,7 @@ <div id="banner"> <div class="pull-left"> <a href="../../index.html" id="bannerLeft"> - <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> </a> </div> <div class="pull-right"> <a href="http://www.apache.org"; id="bannerRight"> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2016-03-11</li> + <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> </ul> </div> @@ -123,6 +123,13 @@ <li> + <a href="../MigrationInstructions.html" title="Migrate to 0.10"> + <i class="none"></i> + Migrate to 0.10</a> + </li> + + <li> + <a href="../Operability.html" title="Operability"> <i class="none"></i> Operability</a> @@ -141,14 +148,14 @@ <i class="none"></i> Client (Falcon CLI)</a> </li> - + <li> <a href="../restapi/ResourceList.html" title="Rest API"> <i class="icon-chevron-down"></i> Rest API</a> <ul class="nav nav-list"> - + <li> <a href="../restapi/ResourceList.html" title="Entity Resource"> @@ -251,16 +258,23 @@ <i class="none"></i> Get feed for given path</a> </li> + + <li> + + <a href="../restapi/FeedSLA.html" title="Get feed instances which missed SLA"> + <i class="none"></i> + Get feed instances which missed SLA</a> + </li> </ul> </li> - + <li> <a href="../restapi/ResourceList.html" title="Feed/Process Instances"> <i class="icon-chevron-right"></i> Feed/Process Instances</a> </li> - + <li> <a href="../restapi/ResourceList.html" title="Admin Resource"> @@ -274,13 +288,20 @@ <i class="icon-chevron-right"></i> Lineage Graph Resource</a> </li> - + <li> <a href="../restapi/ResourceList.html" title="Metadata Resource"> <i class="icon-chevron-right"></i> Metadata Resource</a> </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Falcon Extensions"> + <i class="icon-chevron-right"></i> + Falcon Extensions</a> + </li> </ul> </li> @@ -293,6 +314,13 @@ <li> + <a href="../Extensions.html" title="Server side Extensions"> + <i class="none"></i> + Server side Extensions</a> + </li> + + <li> + <a href="../Security.html" title="Security"> <i class="none"></i> Security</a> @@ -386,6 +414,13 @@ <li> + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.10"; class="externalLink" title="0.10"> + <i class="none"></i> + 0.10</a> + </li> + + <li> + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.9"; class="externalLink" title="0.9"> <i class="none"></i> 0.9</a> @@ -450,9 +485,16 @@ <li> - <a href="../0.9/index.html" title="0.9 (Current)"> + <a href="../0.10/index.html" title="0.10 (Current)"> <i class="none"></i> - 0.9 (Current)</a> + 0.10 (Current)</a> + </li> + + <li> + + <a href="../0.9/index.html" title="0.9"> + <i class="none"></i> + 0.9</a> </li> <li>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionDefinition.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionDefinition.html b/content/restapi/ExtensionDefinition.html new file mode 100644 index 0000000..effa39c --- /dev/null +++ b/content/restapi/ExtensionDefinition.html @@ -0,0 +1,773 @@ +<!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/: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-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://www.apache.org"; id="bannerRight"> + <img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/extension/definition/:extensionÃÂname</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">Falcon</li> + + <li> + + <a href="../index.html" title="About"> + <i class="none"></i> + About</a> + </li> + + <li> + + <a href="../slides/falcon-overview.html" title="Overview"> + <i class="none"></i> + Overview</a> + </li> + + <li> + + <a href="../slides/falcon-user-guide.html" title="User Guide"> + <i class="none"></i> + User Guide</a> + </li> + + <li> + + <a href="../GettingStarted.html" title="Getting Started"> + <i class="none"></i> + Getting Started</a> + </li> + + <li> + + <a href="../FalconDocumentation.html" title="Architecture"> + <i class="none"></i> + Architecture</a> + </li> + + <li> + + <a href="../InstallationSteps.html" title="Installation"> + <i class="none"></i> + Installation</a> + </li> + + <li> + + <a href="../OnBoarding.html" title="On Boarding"> + <i class="none"></i> + On Boarding</a> + </li> + + <li> + + <a href="../MigrationInstructions.html" title="Migrate to 0.10"> + <i class="none"></i> + Migrate to 0.10</a> + </li> + + <li> + + <a href="../Operability.html" title="Operability"> + <i class="none"></i> + Operability</a> + </li> + + <li> + + <a href="../EntitySpecification.html" title="Entity Specification"> + <i class="none"></i> + Entity Specification</a> + </li> + + <li> + + <a href="../falconcli/FalconCLI.html" title="Client (Falcon CLI)"> + <i class="none"></i> + Client (Falcon CLI)</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Rest API"> + <i class="icon-chevron-down"></i> + Rest API</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ResourceList.html" title="Entity Resource"> + <i class="icon-chevron-right"></i> + Entity Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Feed/Process Instances"> + <i class="icon-chevron-right"></i> + Feed/Process Instances</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Admin Resource"> + <i class="icon-chevron-right"></i> + Admin Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Lineage Graph Resource"> + <i class="icon-chevron-right"></i> + Lineage Graph Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Metadata Resource"> + <i class="icon-chevron-right"></i> + Metadata Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Falcon Extensions"> + <i class="icon-chevron-down"></i> + Falcon Extensions</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ExtensionEnumeration.html" title="Enumerate Falcon Extensions"> + <i class="none"></i> + Enumerate Falcon Extensions</a> + </li> + + <li> + + <a href="../restapi/ExtensionDescription.html" title="Describe an Extension"> + <i class="none"></i> + Describe an Extension</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Get JSON Extension properties</a> + </li> + + <li> + + <a href="../restapi/ExtensionList.html" title="List Extension jobs"> + <i class="none"></i> + List Extension jobs</a> + </li> + + <li> + + <a href="../restapi/ExtensionInstances.html" title="List Instances of Extension job"> + <i class="none"></i> + List Instances of Extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionValidate.html" title="Validate Extension Job"> + <i class="none"></i> + Validate Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmit.html" title="Submit Extension Job"> + <i class="none"></i> + Submit Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmitAndSchedule.html" title="Submit and schedule extension job"> + <i class="none"></i> + Submit and schedule extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionUpdate.html" title="Update Extension Job"> + <i class="none"></i> + Update Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSchedule.html" title="Schedule Extension Job"> + <i class="none"></i> + Schedule Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSuspend.html" title="Suspend Extension Job"> + <i class="none"></i> + Suspend Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionResume.html" title="Resume Extension Job"> + <i class="none"></i> + Resume Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionDelete.html" title="Delete Extension Job"> + <i class="none"></i> + Delete Extension Job</a> + </li> + </ul> + </li> + </ul> + </li> + + <li> + + <a href="../HiveIntegration.html" title="Hive Integration"> + <i class="none"></i> + Hive Integration</a> + </li> + + <li> + + <a href="../Extensions.html" title="Server side Extensions"> + <i class="none"></i> + Server side Extensions</a> + </li> + + <li> + + <a href="../Security.html" title="Security"> + <i class="none"></i> + Security</a> + </li> + <li class="nav-header">Project Information</li> + + <li> + + <a href="../project-info.html" title="Summary"> + <i class="none"></i> + Summary</a> + </li> + + <li> + + <a href="../mail-lists.html" title="Mailing Lists"> + <i class="none"></i> + Mailing Lists</a> + </li> + + <li> + + <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4"; class="externalLink" title="IRC"> + <i class="none"></i> + IRC</a> + </li> + + <li> + + <a href="../team-list.html" title="Team"> + <i class="none"></i> + Team</a> + </li> + + <li> + + <a href="../issue-tracking.html" title="Issue Tracking"> + <i class="none"></i> + Issue Tracking</a> + </li> + + <li> + + <a href="../source-repository.html" title="Source Repository"> + <i class="none"></i> + Source Repository</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Index"; class="externalLink" title="Wiki"> + <i class="none"></i> + Wiki</a> + </li> + + <li> + + <a href="../license.html" title="License"> + <i class="none"></i> + License</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/News"; class="externalLink" title="News"> + <i class="none"></i> + News</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy"; class="externalLink" title="Powered by"> + <i class="none"></i> + Powered by</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements"; class="externalLink" title="Acknowledgements"> + <i class="none"></i> + Acknowledgements</a> + </li> + + <li> + + <a href="http://blogs.apache.org/falcon/"; class="externalLink" title="Blog"> + <i class="none"></i> + Blog</a> + </li> + <li class="nav-header">Releases</li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.10"; class="externalLink" title="0.10"> + <i class="none"></i> + 0.10</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.9"; class="externalLink" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.8"; class="externalLink" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.7"; class="externalLink" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/falcon/0.6.1"; class="externalLink" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating"; class="externalLink" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating"; class="externalLink" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating"; class="externalLink" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating"; class="externalLink" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap"; class="externalLink" title="Coming soon"> + <i class="none"></i> + Coming soon</a> + </li> + <li class="nav-header">Documentation</li> + + <li> + + <a href="../0.10/index.html" title="0.10 (Current)"> + <i class="none"></i> + 0.10 (Current)</a> + </li> + + <li> + + <a href="../0.9/index.html" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="../0.8/index.html" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="../0.7/index.html" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="../0.6.1/index.html" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="../0.6-incubating/index.html" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="../0.5-incubating/index.html" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="../0.4-incubating/index.html" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="../0.3-incubating/index.html" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + <li class="nav-header">ASF</li> + + <li> + + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"> + <i class="none"></i> + How Apache Works</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/"; class="externalLink" title="Foundation"> + <i class="none"></i> + Foundation</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"> + <i class="none"></i> + Sponsoring Apache</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + <i class="none"></i> + Thanks</a> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <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> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <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":"[email protected], [email protected], _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":"[email protected], [email protected]" + } + ] +} + +</pre></div></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2013-2016 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionDelete.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionDelete.html b/content/restapi/ExtensionDelete.html new file mode 100644 index 0000000..4d9a29b --- /dev/null +++ b/content/restapi/ExtensionDelete.html @@ -0,0 +1,642 @@ +<!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-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://www.apache.org"; id="bannerRight"> + <img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">POST api/extension/delete/:job-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">Falcon</li> + + <li> + + <a href="../index.html" title="About"> + <i class="none"></i> + About</a> + </li> + + <li> + + <a href="../slides/falcon-overview.html" title="Overview"> + <i class="none"></i> + Overview</a> + </li> + + <li> + + <a href="../slides/falcon-user-guide.html" title="User Guide"> + <i class="none"></i> + User Guide</a> + </li> + + <li> + + <a href="../GettingStarted.html" title="Getting Started"> + <i class="none"></i> + Getting Started</a> + </li> + + <li> + + <a href="../FalconDocumentation.html" title="Architecture"> + <i class="none"></i> + Architecture</a> + </li> + + <li> + + <a href="../InstallationSteps.html" title="Installation"> + <i class="none"></i> + Installation</a> + </li> + + <li> + + <a href="../OnBoarding.html" title="On Boarding"> + <i class="none"></i> + On Boarding</a> + </li> + + <li> + + <a href="../MigrationInstructions.html" title="Migrate to 0.10"> + <i class="none"></i> + Migrate to 0.10</a> + </li> + + <li> + + <a href="../Operability.html" title="Operability"> + <i class="none"></i> + Operability</a> + </li> + + <li> + + <a href="../EntitySpecification.html" title="Entity Specification"> + <i class="none"></i> + Entity Specification</a> + </li> + + <li> + + <a href="../falconcli/FalconCLI.html" title="Client (Falcon CLI)"> + <i class="none"></i> + Client (Falcon CLI)</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Rest API"> + <i class="icon-chevron-down"></i> + Rest API</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ResourceList.html" title="Entity Resource"> + <i class="icon-chevron-right"></i> + Entity Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Feed/Process Instances"> + <i class="icon-chevron-right"></i> + Feed/Process Instances</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Admin Resource"> + <i class="icon-chevron-right"></i> + Admin Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Lineage Graph Resource"> + <i class="icon-chevron-right"></i> + Lineage Graph Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Metadata Resource"> + <i class="icon-chevron-right"></i> + Metadata Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Falcon Extensions"> + <i class="icon-chevron-down"></i> + Falcon Extensions</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ExtensionEnumeration.html" title="Enumerate Falcon Extensions"> + <i class="none"></i> + Enumerate Falcon Extensions</a> + </li> + + <li> + + <a href="../restapi/ExtensionDescription.html" title="Describe an Extension"> + <i class="none"></i> + Describe an Extension</a> + </li> + + <li> + + <a href="../restapi/ExtensionDefinition.html" title="Get JSON Extension properties"> + <i class="none"></i> + Get JSON Extension properties</a> + </li> + + <li> + + <a href="../restapi/ExtensionList.html" title="List Extension jobs"> + <i class="none"></i> + List Extension jobs</a> + </li> + + <li> + + <a href="../restapi/ExtensionInstances.html" title="List Instances of Extension job"> + <i class="none"></i> + List Instances of Extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionValidate.html" title="Validate Extension Job"> + <i class="none"></i> + Validate Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmit.html" title="Submit Extension Job"> + <i class="none"></i> + Submit Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmitAndSchedule.html" title="Submit and schedule extension job"> + <i class="none"></i> + Submit and schedule extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionUpdate.html" title="Update Extension Job"> + <i class="none"></i> + Update Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSchedule.html" title="Schedule Extension Job"> + <i class="none"></i> + Schedule Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSuspend.html" title="Suspend Extension Job"> + <i class="none"></i> + Suspend Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionResume.html" title="Resume Extension Job"> + <i class="none"></i> + Resume Extension Job</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Delete Extension Job</a> + </li> + </ul> + </li> + </ul> + </li> + + <li> + + <a href="../HiveIntegration.html" title="Hive Integration"> + <i class="none"></i> + Hive Integration</a> + </li> + + <li> + + <a href="../Extensions.html" title="Server side Extensions"> + <i class="none"></i> + Server side Extensions</a> + </li> + + <li> + + <a href="../Security.html" title="Security"> + <i class="none"></i> + Security</a> + </li> + <li class="nav-header">Project Information</li> + + <li> + + <a href="../project-info.html" title="Summary"> + <i class="none"></i> + Summary</a> + </li> + + <li> + + <a href="../mail-lists.html" title="Mailing Lists"> + <i class="none"></i> + Mailing Lists</a> + </li> + + <li> + + <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4"; class="externalLink" title="IRC"> + <i class="none"></i> + IRC</a> + </li> + + <li> + + <a href="../team-list.html" title="Team"> + <i class="none"></i> + Team</a> + </li> + + <li> + + <a href="../issue-tracking.html" title="Issue Tracking"> + <i class="none"></i> + Issue Tracking</a> + </li> + + <li> + + <a href="../source-repository.html" title="Source Repository"> + <i class="none"></i> + Source Repository</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Index"; class="externalLink" title="Wiki"> + <i class="none"></i> + Wiki</a> + </li> + + <li> + + <a href="../license.html" title="License"> + <i class="none"></i> + License</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/News"; class="externalLink" title="News"> + <i class="none"></i> + News</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy"; class="externalLink" title="Powered by"> + <i class="none"></i> + Powered by</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements"; class="externalLink" title="Acknowledgements"> + <i class="none"></i> + Acknowledgements</a> + </li> + + <li> + + <a href="http://blogs.apache.org/falcon/"; class="externalLink" title="Blog"> + <i class="none"></i> + Blog</a> + </li> + <li class="nav-header">Releases</li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.10"; class="externalLink" title="0.10"> + <i class="none"></i> + 0.10</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.9"; class="externalLink" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.8"; class="externalLink" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.7"; class="externalLink" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/falcon/0.6.1"; class="externalLink" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating"; class="externalLink" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating"; class="externalLink" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating"; class="externalLink" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating"; class="externalLink" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap"; class="externalLink" title="Coming soon"> + <i class="none"></i> + Coming soon</a> + </li> + <li class="nav-header">Documentation</li> + + <li> + + <a href="../0.10/index.html" title="0.10 (Current)"> + <i class="none"></i> + 0.10 (Current)</a> + </li> + + <li> + + <a href="../0.9/index.html" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="../0.8/index.html" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="../0.7/index.html" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="../0.6.1/index.html" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="../0.6-incubating/index.html" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="../0.5-incubating/index.html" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="../0.4-incubating/index.html" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="../0.3-incubating/index.html" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + <li class="nav-header">ASF</li> + + <li> + + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"> + <i class="none"></i> + How Apache Works</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/"; class="externalLink" title="Foundation"> + <i class="none"></i> + Foundation</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"> + <i class="none"></i> + Sponsoring Apache</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + <i class="none"></i> + Thanks</a> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <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> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <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> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2013-2016 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionDescription.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionDescription.html b/content/restapi/ExtensionDescription.html new file mode 100644 index 0000000..d256084 --- /dev/null +++ b/content/restapi/ExtensionDescription.html @@ -0,0 +1,637 @@ +<!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/: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-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://www.apache.org"; id="bannerRight"> + <img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/extension/describe/:extensionÃÂname</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">Falcon</li> + + <li> + + <a href="../index.html" title="About"> + <i class="none"></i> + About</a> + </li> + + <li> + + <a href="../slides/falcon-overview.html" title="Overview"> + <i class="none"></i> + Overview</a> + </li> + + <li> + + <a href="../slides/falcon-user-guide.html" title="User Guide"> + <i class="none"></i> + User Guide</a> + </li> + + <li> + + <a href="../GettingStarted.html" title="Getting Started"> + <i class="none"></i> + Getting Started</a> + </li> + + <li> + + <a href="../FalconDocumentation.html" title="Architecture"> + <i class="none"></i> + Architecture</a> + </li> + + <li> + + <a href="../InstallationSteps.html" title="Installation"> + <i class="none"></i> + Installation</a> + </li> + + <li> + + <a href="../OnBoarding.html" title="On Boarding"> + <i class="none"></i> + On Boarding</a> + </li> + + <li> + + <a href="../MigrationInstructions.html" title="Migrate to 0.10"> + <i class="none"></i> + Migrate to 0.10</a> + </li> + + <li> + + <a href="../Operability.html" title="Operability"> + <i class="none"></i> + Operability</a> + </li> + + <li> + + <a href="../EntitySpecification.html" title="Entity Specification"> + <i class="none"></i> + Entity Specification</a> + </li> + + <li> + + <a href="../falconcli/FalconCLI.html" title="Client (Falcon CLI)"> + <i class="none"></i> + Client (Falcon CLI)</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Rest API"> + <i class="icon-chevron-down"></i> + Rest API</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ResourceList.html" title="Entity Resource"> + <i class="icon-chevron-right"></i> + Entity Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Feed/Process Instances"> + <i class="icon-chevron-right"></i> + Feed/Process Instances</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Admin Resource"> + <i class="icon-chevron-right"></i> + Admin Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Lineage Graph Resource"> + <i class="icon-chevron-right"></i> + Lineage Graph Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Metadata Resource"> + <i class="icon-chevron-right"></i> + Metadata Resource</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Falcon Extensions"> + <i class="icon-chevron-down"></i> + Falcon Extensions</a> + <ul class="nav nav-list"> + + <li> + + <a href="../restapi/ExtensionEnumeration.html" title="Enumerate Falcon Extensions"> + <i class="none"></i> + Enumerate Falcon Extensions</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Describe an Extension</a> + </li> + + <li> + + <a href="../restapi/ExtensionDefinition.html" title="Get JSON Extension properties"> + <i class="none"></i> + Get JSON Extension properties</a> + </li> + + <li> + + <a href="../restapi/ExtensionList.html" title="List Extension jobs"> + <i class="none"></i> + List Extension jobs</a> + </li> + + <li> + + <a href="../restapi/ExtensionInstances.html" title="List Instances of Extension job"> + <i class="none"></i> + List Instances of Extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionValidate.html" title="Validate Extension Job"> + <i class="none"></i> + Validate Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmit.html" title="Submit Extension Job"> + <i class="none"></i> + Submit Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSubmitAndSchedule.html" title="Submit and schedule extension job"> + <i class="none"></i> + Submit and schedule extension job</a> + </li> + + <li> + + <a href="../restapi/ExtensionUpdate.html" title="Update Extension Job"> + <i class="none"></i> + Update Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSchedule.html" title="Schedule Extension Job"> + <i class="none"></i> + Schedule Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionSuspend.html" title="Suspend Extension Job"> + <i class="none"></i> + Suspend Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionResume.html" title="Resume Extension Job"> + <i class="none"></i> + Resume Extension Job</a> + </li> + + <li> + + <a href="../restapi/ExtensionDelete.html" title="Delete Extension Job"> + <i class="none"></i> + Delete Extension Job</a> + </li> + </ul> + </li> + </ul> + </li> + + <li> + + <a href="../HiveIntegration.html" title="Hive Integration"> + <i class="none"></i> + Hive Integration</a> + </li> + + <li> + + <a href="../Extensions.html" title="Server side Extensions"> + <i class="none"></i> + Server side Extensions</a> + </li> + + <li> + + <a href="../Security.html" title="Security"> + <i class="none"></i> + Security</a> + </li> + <li class="nav-header">Project Information</li> + + <li> + + <a href="../project-info.html" title="Summary"> + <i class="none"></i> + Summary</a> + </li> + + <li> + + <a href="../mail-lists.html" title="Mailing Lists"> + <i class="none"></i> + Mailing Lists</a> + </li> + + <li> + + <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4"; class="externalLink" title="IRC"> + <i class="none"></i> + IRC</a> + </li> + + <li> + + <a href="../team-list.html" title="Team"> + <i class="none"></i> + Team</a> + </li> + + <li> + + <a href="../issue-tracking.html" title="Issue Tracking"> + <i class="none"></i> + Issue Tracking</a> + </li> + + <li> + + <a href="../source-repository.html" title="Source Repository"> + <i class="none"></i> + Source Repository</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Index"; class="externalLink" title="Wiki"> + <i class="none"></i> + Wiki</a> + </li> + + <li> + + <a href="../license.html" title="License"> + <i class="none"></i> + License</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/News"; class="externalLink" title="News"> + <i class="none"></i> + News</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy"; class="externalLink" title="Powered by"> + <i class="none"></i> + Powered by</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements"; class="externalLink" title="Acknowledgements"> + <i class="none"></i> + Acknowledgements</a> + </li> + + <li> + + <a href="http://blogs.apache.org/falcon/"; class="externalLink" title="Blog"> + <i class="none"></i> + Blog</a> + </li> + <li class="nav-header">Releases</li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.10"; class="externalLink" title="0.10"> + <i class="none"></i> + 0.10</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.9"; class="externalLink" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.8"; class="externalLink" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.7"; class="externalLink" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/falcon/0.6.1"; class="externalLink" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating"; class="externalLink" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating"; class="externalLink" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating"; class="externalLink" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating"; class="externalLink" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap"; class="externalLink" title="Coming soon"> + <i class="none"></i> + Coming soon</a> + </li> + <li class="nav-header">Documentation</li> + + <li> + + <a href="../0.10/index.html" title="0.10 (Current)"> + <i class="none"></i> + 0.10 (Current)</a> + </li> + + <li> + + <a href="../0.9/index.html" title="0.9"> + <i class="none"></i> + 0.9</a> + </li> + + <li> + + <a href="../0.8/index.html" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="../0.7/index.html" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="../0.6.1/index.html" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="../0.6-incubating/index.html" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="../0.5-incubating/index.html" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="../0.4-incubating/index.html" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="../0.3-incubating/index.html" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + <li class="nav-header">ASF</li> + + <li> + + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"> + <i class="none"></i> + How Apache Works</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/"; class="externalLink" title="Foundation"> + <i class="none"></i> + Foundation</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"> + <i class="none"></i> + Sponsoring Apache</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + <i class="none"></i> + Thanks</a> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <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> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <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> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2013-2016 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
