Modified: falcon/site/0.3-incubating/docs/FalconCLI.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/FalconCLI.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/FalconCLI.html (original) +++ falcon/site/0.3-incubating/docs/FalconCLI.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - FalconCLI</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,86 +70,228 @@ <div id="bodyColumn" > - <div class="section"><h2>FalconCLI<a name="FalconCLI"></a></h2><p>FalconCLI is a interface between user and Falcon. It is a command line utility provided by Falcon. FalconCLI supports Entity Management, Instance Management and Admin operations.There is a set of web services that are used by FalconCLI to interact with Falcon.</p></div><div class="section"><h3>Entity Management Operations<a name="Entity_Management_Operations"></a></h3></div><div class="section"><h4>Submit<a name="Submit"></a></h4><p>Entity submit action allows a new cluster/feed/process to be setup within Falcon. Submitted entity is not scheduled, meaning it would simply be in the configuration store within Falcon. Besides validating against the schema for the corresponding entity being added, the Falcon system would also perform inter-field validations within the configuration file and validations across dependent entities.</p><div class="source"><pre class="prettyprint"> + <div class="section"> +<h2>FalconCLI<a name="FalconCLI"></a></h2> +<p>FalconCLI is a interface between user and Falcon. It is a command line utility provided by Falcon. FalconCLI supports Entity Management, Instance Management and Admin operations.There is a set of web services that are used by FalconCLI to interact with Falcon.</p></div> +<div class="section"> +<h3>Entity Management Operations<a name="Entity_Management_Operations"></a></h3></div> +<div class="section"> +<h4>Submit<a name="Submit"></a></h4> +<p>Entity submit action allows a new cluster/feed/process to be setup within Falcon. Submitted entity is not scheduled, meaning it would simply be in the configuration store within Falcon. Besides validating against the schema for the corresponding entity being added, the Falcon system would also perform inter-field validations within the configuration file and validations across dependent entities.</p> +<div class="source"> +<pre> Example: $FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml -</pre></div><p>Note: The url option in the above and all subsequent commands is optional. If not mentioned it will be picked from client.properties file. If the option is not provided and also not set in client.properties, Falcon CLI will fail.</p></div><div class="section"><h4>Schedule<a name="Schedule"></a></h4><p>Feeds or Processes that are already submitted and present in the config store can be scheduled. Upon schedule, Falcon system wraps the required repeatable action as a bundle of oozie coordinators and executes them on the Oozie scheduler. (It is possible to extend Falcon to use an alternate workflow engine other than Oozie). Falcon overrides the workflow instance's external id in Oozie to reflect the process/feed and the nominal time. This external Id can then be used for instance management functions.</p><div class="source"><pre class="prettyprint"> +</pre></div> +<p>Note: The url option in the above and all subsequent commands is optional. If not mentioned it will be picked from client.properties file. If the option is not provided and also not set in client.properties, Falcon CLI will fail.</p></div> +<div class="section"> +<h4>Schedule<a name="Schedule"></a></h4> +<p>Feeds or Processes that are already submitted and present in the config store can be scheduled. Upon schedule, Falcon system wraps the required repeatable action as a bundle of oozie coordinators and executes them on the Oozie scheduler. (It is possible to extend Falcon to use an alternate workflow engine other than Oozie). Falcon overrides the workflow instance's external id in Oozie to reflect the process/feed and the nominal time. This external Id can then be used for instance management functions.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [process|feed] -name <<name>> -schedule Example: $FALCON_HOME/bin/falcon entity -type process -name sampleProcess -schedule -</pre></div></div><div class="section"><h4>Suspend<a name="Suspend"></a></h4><p>This action is applicable only on scheduled entity. This triggers suspend on the oozie bundle that was scheduled earlier through the schedule function. No further instances are executed on a suspended process/feed.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Suspend<a name="Suspend"></a></h4> +<p>This action is applicable only on scheduled entity. This triggers suspend on the oozie bundle that was scheduled earlier through the schedule function. No further instances are executed on a suspended process/feed.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -suspend -</pre></div></div><div class="section"><h4>Resume<a name="Resume"></a></h4><p>Puts a suspended process/feed back to active, which in turn resumes applicable oozie bundle.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Resume<a name="Resume"></a></h4> +<p>Puts a suspended process/feed back to active, which in turn resumes applicable oozie bundle.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -resume -</pre></div></div><div class="section"><h4>Delete<a name="Delete"></a></h4><p>Delete operation on the entity removes any scheduled activity on the workflow engine, besides removing the entity from the falcon configuration store. Delete operation on an entity would only succeed if there are no dependent entities on the deleted entity.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Delete<a name="Delete"></a></h4> +<p>Delete operation on the entity removes any scheduled activity on the workflow engine, besides removing the entity from the falcon configuration store. Delete operation on an entity would only succeed if there are no dependent entities on the deleted entity.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -delete -</pre></div></div><div class="section"><h4>List<a name="List"></a></h4><p>List all the entities within the falcon config store for the entity type being requested. This will include both scheduled and submitted entity configurations.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>List<a name="List"></a></h4> +<p>List all the entities within the falcon config store for the entity type being requested. This will include both scheduled and submitted entity configurations.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -list -</pre></div></div><div class="section"><h4>Update<a name="Update"></a></h4><p>Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed. Feed update can cause cascading update to all the processes already scheduled. The following set of actions are performed in Oozie to realize an update.</p><p></p><ul><li>Suspend the previously scheduled Oozie coordinator. This is prevent any new action from being triggered.</li><li>Update the coordinator to set the end time to "now"</li><li>Resume the suspended coordiantors</li><li>Schedule as per the new process/feed definition with the start time as "now"</li></ul><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Update<a name="Update"></a></h4> +<p>Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed. Feed update can cause cascading update to all the processes already scheduled. The following set of actions are performed in Oozie to realize an update.</p> +<p></p> +<ul> +<li>Suspend the previously scheduled Oozie coordinator. This is prevent any new action from being triggered.</li> +<li>Update the coordinator to set the end time to "now"</li> +<li>Resume the suspended coordiantors</li> +<li>Schedule as per the new process/feed definition with the start time as "now"</li></ul> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -update -</pre></div></div><div class="section"><h4>Status<a name="Status"></a></h4><p>Status returns the current status of the entity.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Status<a name="Status"></a></h4> +<p>Status returns the current status of the entity.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -status -</pre></div></div><div class="section"><h4>Dependency<a name="Dependency"></a></h4><p>Returns the dependencies of the requested entity. Dependency list include both forward and backward dependencies (depends on & is dependent on). For ex, a feed would show process that are dependent on the feed and the clusters that it depends on.'</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Dependency<a name="Dependency"></a></h4> +<p>Returns the dependencies of the requested entity. Dependency list include both forward and backward dependencies (depends on & is dependent on). For ex, a feed would show process that are dependent on the feed and the clusters that it depends on.'</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -dependency -</pre></div></div><div class="section"><h4>Definition<a name="Definition"></a></h4><p>Gets the current entity definition as stored in the configuration store. Please note that user documentations in the entity will not be retained.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Definition<a name="Definition"></a></h4> +<p>Gets the current entity definition as stored in the configuration store. Please note that user documentations in the entity will not be retained.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -definition -</pre></div></div><div class="section"><h3>Instance Management Options<a name="Instance_Management_Options"></a></h3><p>Instance Manager gives user the option to control individual instances of the process based on their instance start time (start time of that instance). Start time needs to be given in standard TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p><p>All the instance management operations (except running) allow single instance or list of instance within a Date range to be acted on. Make sure the dates are valid. i.e are within the start and end time of process itself.</p><p>For every query in instance management the process name is a compulsory parameter.</p><p>Parameters -start and -end are used to mention the date range within which you want the instance to be operated upon.</p><p>-start: using only "-start" without "-end" will conduct the desired operation only on single instance given by date along with start.</p><p>-end: "-end" can only be used along with "-start" . It corresponds to the end date till which instance need to operated upon.</p><p></p><ul><li>1. <b>status</b>: -status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state.Along with the status of the instance log location is also returned.</li></ul><p></p><ul><li>2. <b>running</b>: -running returns all the running instance of the process. It does not take any start or end dates but simply return all the instances in state RUNNING at that given time.</li></ul><p></p><ul><li>3. <b>rerun</b>: -rerun is the option that you will use most often from instance management. As the name suggest this option is used to rerun a particular instance or instances of the process. The rerun option reruns all parent workflow for the instance, which in turn rerun all the sub-workflows for it. Thi s option is valid for any instance in terminal state, i.e. KILLED, SUCCEEDED, FAILED. User can also set properties in the request, which will give options what types of actions should be rerun like, only failed, run all etc. These properties are dependent on the workflow engine being used along with falcon.</li></ul><p></p><ul><li>4. <b>suspend</b>: -suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command. This command is similar to SUSPEND process command in functionality only difference being, SUSPEND process suspends all the instance whereas suspend instance suspend only that instance or instances in the range.</li></ul><p></p><ul><li>5. <b>resume</b>: -resume option is used to resume any instance that is in suspended state. (Note: due to a bug in oozie �resume option in some cases may not actually resume the suspended instance/ insta nces)</li><li>6. <b>kill</b>: -kill option can be used to kill an instance or multiple instances</li></ul><p>In all the cases where your request is syntactically correct but logically not, the instance / instances are returned with the same status as earlier. Example: trying to resume a KILLED / SUCCEEDED instance will return the instance with KILLED / SUCCEEDED, without actually performing any operation. This is so because only an instance in SUSPENDED state can be resumed. Same thing is valid for rerun a SUSPENDED or RUNNING options etc.</p></div><div class="section"><h4>Status<a name="Status"></a></h4><p>Status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Along with the status of the instance time is also returned. Log location gives the oozie workflow url If the instance is in WAITING state, missing dependencies are listed</p>< p>Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is:</p><p>{"status":"SUCCEEDED","message":"getStatus is successful","instances":[{"instance":"2012-05-07T05:02Z","status":"SUCCEEDED","logFile":"http://oozie-dashboard-url"},{"instance":"2012-05-07T05:07Z","status":"RUNNING","logFile":"http://oozie-dashboard-url"}, {"instance":"2010-01-02T11:05Z","status":"WAITING"}]</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h3>Instance Management Options<a name="Instance_Management_Options"></a></h3> +<p>Instance Manager gives user the option to control individual instances of the process based on their instance start time (start time of that instance). Start time needs to be given in standard TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p> +<p>All the instance management operations (except running) allow single instance or list of instance within a Date range to be acted on. Make sure the dates are valid. i.e are within the start and end time of process itself.</p> +<p>For every query in instance management the process name is a compulsory parameter.</p> +<p>Parameters -start and -end are used to mention the date range within which you want the instance to be operated upon.</p> +<p>-start: using only "-start" without "-end" will conduct the desired operation only on single instance given by date along with start.</p> +<p>-end: "-end" can only be used along with "-start" . It corresponds to the end date till which instance need to operated upon.</p> +<p></p> +<ul> +<li>1. <b>status</b>: -status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state.Along with the status of the instance log location is also returned.</li></ul> +<p></p> +<ul> +<li>2. <b>running</b>: -running returns all the running instance of the process. It does not take any start or end dates but simply return all the instances in state RUNNING at that given time.</li></ul> +<p></p> +<ul> +<li>3. <b>rerun</b>: -rerun is the option that you will use most often from instance management. As the name suggest this option is used to rerun a particular instance or instances of the process. The rerun option reruns all parent workflow for the instance, which in turn rerun all the sub-workflows for it. This option is valid for any instance in terminal state, i.e. KILLED, SUCCEEDED, FAILED. User can also set properties in the request, which will give options what types of actions should be rerun like, only failed, run all etc. These properties are dependent on the workflow engine being used along with falcon.</li></ul> +<p></p> +<ul> +<li>4. <b>suspend</b>: -suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command. This command is similar to SUSPEND process command in functionality only difference being, SUSPEND process suspends all the instance whereas suspend instance suspend only that instance or instances in the range.</li></ul> +<p></p> +<ul> +<li>5. <b>resume</b>: -resume option is used to resume any instance that is in suspended state. (Note: due to a bug in oozie �resume option in some cases may not actually resume the suspended instance/ instances)</li> +<li>6. <b>kill</b>: -kill option can be used to kill an instance or multiple instances</li></ul> +<p>In all the cases where your request is syntactically correct but logically not, the instance / instances are returned with the same status as earlier. Example: trying to resume a KILLED / SUCCEEDED instance will return the instance with KILLED / SUCCEEDED, without actually performing any operation. This is so because only an instance in SUSPENDED state can be resumed. Same thing is valid for rerun a SUSPENDED or RUNNING options etc.</p></div> +<div class="section"> +<h4>Status<a name="Status"></a></h4> +<p>Status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Along with the status of the instance time is also returned. Log location gives the oozie workflow url If the instance is in WAITING state, missing dependencies are listed</p> +<p>Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is:</p> +<p>{"status":"SUCCEEDED","message":"getStatus is successful","instances":[{"instance":"2012-05-07T05:02Z","status":"SUCCEEDED","logFile":"http://oozie-dashboard-url"},{"instance":"2012-05-07T05:07Z","status":"RUNNING","logFile":"http://oozie-dashboard-url"}, {"instance":"2010-01-02T11:05Z","status":"WAITING"}]</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -</pre></div></div><div class="section"><h4>Kill<a name="Kill"></a></h4><p>Kill sub-command is used to kill all the instances of the specified process whose nominal time is between the given start time and end time.</p><p>Note: 1. For all the instance management sub-commands, if end time is not specified, Falcon will perform the actions on all the instances whose instance time falls after the start time.</p><p>2. The start time and end time needs to be specified in TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p><p>3. Process name is compulsory parameter for each instance management command.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Kill<a name="Kill"></a></h4> +<p>Kill sub-command is used to kill all the instances of the specified process whose nominal time is between the given start time and end time.</p> +<p>Note: 1. For all the instance management sub-commands, if end time is not specified, Falcon will perform the actions on all the instances whose instance time falls after the start time.</p> +<p>2. The start time and end time needs to be specified in TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p> +<p>3. Process name is compulsory parameter for each instance management command.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -kill -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -</pre></div></div><div class="section"><h4>Suspend<a name="Suspend"></a></h4><p>Suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Suspend<a name="Suspend"></a></h4> +<p>Suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -suspend -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -</pre></div></div><div class="section"><h4>Continue<a name="Continue"></a></h4><p>Continue option is used to continue the failed workflow instance. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Continue<a name="Continue"></a></h4> +<p>Continue option is used to continue the failed workflow instance. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -re-run -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -</pre></div></div><div class="section"><h4>Rerun<a name="Rerun"></a></h4><p>Rerun option is used to rerun instances of a given process. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED. Optionally, you can specify the properties to override.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Rerun<a name="Rerun"></a></h4> +<p>Rerun option is used to rerun instances of a given process. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED. Optionally, you can specify the properties to override.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -re-run -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" [-file <<properties file>>] -</pre></div></div><div class="section"><h4>Resume<a name="Resume"></a></h4><p>Resume option is used to resume any instance that is in suspended state.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Resume<a name="Resume"></a></h4> +<p>Resume option is used to resume any instance that is in suspended state.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -resume -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -</pre></div></div><div class="section"><h4>Running<a name="Running"></a></h4><p>Running option provides all the running instances of the mentioned process.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Running<a name="Running"></a></h4> +<p>Running option provides all the running instances of the mentioned process.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -running -</pre></div></div><div class="section"><h4>Logs<a name="Logs"></a></h4><p>Get logs for instance actions</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Logs<a name="Logs"></a></h4> +<p>Get logs for instance actions</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -logs -start "yyyy-MM-dd'T'HH:mm'Z'" [-end "yyyy-MM-dd'T'HH:mm'Z'"] [-runid <<runid>>] -</pre></div></div><div class="section"><h3>Admin Options<a name="Admin_Options"></a></h3></div><div class="section"><h4>Help<a name="Help"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h3>Admin Options<a name="Admin_Options"></a></h3></div> +<div class="section"> +<h4>Help<a name="Help"></a></h4> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon admin -version -</pre></div></div><div class="section"><h4>Version<a name="Version"></a></h4><p>Version returns the current verion of Falcon installed.</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Version<a name="Version"></a></h4> +<p>Version returns the current verion of Falcon installed.</p> +<div class="source"> +<pre> Usage: $FALCON_HOME/bin/falcon admin -help @@ -161,7 +303,7 @@ $FALCON_HOME/bin/falcon admin -help <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.
Modified: falcon/site/0.3-incubating/docs/InstallationSteps.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/InstallationSteps.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/InstallationSteps.html (original) +++ falcon/site/0.3-incubating/docs/InstallationSteps.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - Building & Installing Falcon</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,7 +70,13 @@ <div id="bodyColumn" > - <div class="section"><h3>Building & Installing Falcon<a name="Building__Installing_Falcon"></a></h3></div><div class="section"><h4>Building Falcon<a name="Building_Falcon"></a></h4><p>Download sources from <a class="externalLink" href="http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz";>http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz</a></p><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>Building & Installing Falcon<a name="Building__Installing_Falcon"></a></h3></div> +<div class="section"> +<h4>Building Falcon<a name="Building_Falcon"></a></h4> +<p>Download sources from <a class="externalLink" href="http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz";>http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz</a></p> +<div class="source"> +<pre> tar -xzvf falcon-0.3-incubating-sources.tar.gz @@ -109,14 +115,26 @@ Tar is structured as follows |- falcon.pid -</pre></div><p>PS: By default the falcon is built for embedded mode.</p></div><div class="section"><h4>Installing & running Falcon<a name="Installing__running_Falcon"></a></h4><p><b>Installing falcon</b></p><div class="source"><pre class="prettyprint"> +</pre></div> +<p>PS: By default the falcon is built for embedded mode.</p></div> +<div class="section"> +<h4>Installing & running Falcon<a name="Installing__running_Falcon"></a></h4> +<p><b>Installing falcon</b></p> +<div class="source"> +<pre> tar -xzvf falcon-0.3-incubating-bin.tar.gz cd falcon-0.3-incubating-bin -</pre></div><p><b>Starting Falcon Server</b></p><div class="source"><pre class="prettyprint"> +</pre></div> +<p><b>Starting Falcon Server</b></p> +<div class="source"> +<pre> bin/falcon-start -</pre></div><p><b>Using Falcon</b></p><div class="source"><pre class="prettyprint"> +</pre></div> +<p><b>Using Falcon</b></p> +<div class="source"> +<pre> bin/falcon admin -version Falcon server build version: {Version:"0.3-incubating-r4380d446a912252a8c173c43a858ab1a38443c47",Mode:"embedded"} @@ -125,10 +143,17 @@ Falcon server build version: {Version:&q bin/falcon help (for more details about falcon cli usage) -</pre></div><p><b>Stopping Falcon Server</b></p><div class="source"><pre class="prettyprint"> +</pre></div> +<p><b>Stopping Falcon Server</b></p> +<div class="source"> +<pre> bin/falcon-stop -</pre></div></div><div class="section"><h4>Preparing oozie bundle for use with Falcon<a name="Preparing_oozie_bundle_for_use_with_Falcon"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Preparing oozie bundle for use with Falcon<a name="Preparing_oozie_bundle_for_use_with_Falcon"></a></h4> +<div class="source"> +<pre> cd <<project home>> mkdir target/package src/bin/pacakge.sh <<hadoop-version>> @@ -144,7 +169,7 @@ src/bin/pacakge.sh <<hadoop-versio <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/OnBoarding.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/OnBoarding.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/OnBoarding.html (original) +++ falcon/site/0.3-incubating/docs/OnBoarding.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - Contents</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,7 +70,30 @@ <div id="bodyColumn" > - <div class="section"><h3>Contents<a name="Contents"></a></h3><p></p><ul><li><a href="#Onboarding Steps">Onboarding Steps</a></li><li><a href="#Sample Pipeline">Sample Pipeline</a></li></ul></div><div class="section"><h4>Onboarding Steps<a name="Onboarding_Steps"></a></h4><p></p><ul><li>Create cluster definition for the cluster, specifying name node, job tracker, workflow engine endpoint, messaging endpoint. Refer to <a href="./EntitySpecification.html">cluster definition</a> for details.</li><li>Create Feed definitions for each of the input and output specifying frequency, data path, ownership. Refer to <a href="./EntitySpecification.html">feed definition</a> for details.</li><li>Create Process definition for your job. Process defines configuration for the workflow job. Important attributes are frequency, inputs/outputs and workflow path. Refer to <a href="./EntitySpecification.html">process definition</a> for process details.</li><li>Define workflow for your job using t he workflow engine(only oozie is supported as of now). Refer <a class="externalLink" href="http://incubator.apache.org/oozie/docs/3.1.3/docs/WorkflowFunctionalSpec.html";>Oozie Workflow Specification</a>. The libraries required for the workflow should be available in lib folder in workflow path.</li><li>Set-up workflow definition, libraries and referenced scripts on hadoop.</li><li>Submit cluster definition</li><li>Submit and schedule feed and process definitions</li></ul></div><div class="section"><h4>Sample Pipeline<a name="Sample_Pipeline"></a></h4></div><div class="section"><h5>Cluster <a name="Cluster"></a></h5><p>Cluster definition that contains end points for name node, job tracker, oozie and jms server:</p><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>Contents<a name="Contents"></a></h3> +<p></p> +<ul> +<li><a href="#Onboarding Steps">Onboarding Steps</a></li> +<li><a href="#Sample Pipeline">Sample Pipeline</a></li></ul></div> +<div class="section"> +<h4>Onboarding Steps<a name="Onboarding_Steps"></a></h4> +<p></p> +<ul> +<li>Create cluster definition for the cluster, specifying name node, job tracker, workflow engine endpoint, messaging endpoint. Refer to <a href="./EntitySpecification.html">cluster definition</a> for details.</li> +<li>Create Feed definitions for each of the input and output specifying frequency, data path, ownership. Refer to <a href="./EntitySpecification.html">feed definition</a> for details.</li> +<li>Create Process definition for your job. Process defines configuration for the workflow job. Important attributes are frequency, inputs/outputs and workflow path. Refer to <a href="./EntitySpecification.html">process definition</a> for process details.</li> +<li>Define workflow for your job using the workflow engine(only oozie is supported as of now). Refer <a class="externalLink" href="http://incubator.apache.org/oozie/docs/3.1.3/docs/WorkflowFunctionalSpec.html";>Oozie Workflow Specification</a>. The libraries required for the workflow should be available in lib folder in workflow path.</li> +<li>Set-up workflow definition, libraries and referenced scripts on hadoop.</li> +<li>Submit cluster definition</li> +<li>Submit and schedule feed and process definitions</li></ul></div> +<div class="section"> +<h4>Sample Pipeline<a name="Sample_Pipeline"></a></h4></div> +<div class="section"> +<h5>Cluster <a name="Cluster"></a></h5> +<p>Cluster definition that contains end points for name node, job tracker, oozie and jms server:</p> +<div class="source"> +<pre> <?xml version="1.0"?> <!-- Cluster configuration @@ -96,7 +119,12 @@ </locations> </cluster> -</pre></div></div><div class="section"><h5>Input Feed<a name="Input_Feed"></a></h5><p>Hourly feed that defines feed path, frequency, ownership and validity:</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h5>Input Feed<a name="Input_Feed"></a></h5> +<p>Hourly feed that defines feed path, frequency, ownership and validity:</p> +<div class="source"> +<pre> <?xml version="1.0" encoding="UTF-8"?> <!-- Hourly sample input data @@ -128,7 +156,12 @@ <schema location="/none" provider="none" /> </feed> -</pre></div></div><div class="section"><h5>Output Feed<a name="Output_Feed"></a></h5><p>Daily feed that defines feed path, frequency, ownership and validity:</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h5>Output Feed<a name="Output_Feed"></a></h5> +<p>Daily feed that defines feed path, frequency, ownership and validity:</p> +<div class="source"> +<pre> <?xml version="1.0" encoding="UTF-8"?> <!-- Daily sample output data @@ -160,7 +193,12 @@ xmlns:xsi="http://www.w3.org/2001/X <schema location="/none" provider="none" /> </feed> -</pre></div></div><div class="section"><h5>Process<a name="Process"></a></h5><p>Sample process which runs daily at 6th hour on corp cluster. It takes one input - <a href="./SampleInput.html">SampleInput</a> for the previous day(24 instances). It generates one output - <a href="./SampleOutput.html">SampleOutput</a> for previous day. The workflow is defined at /projects/bootcamp/workflow/workflow.xml. Any libraries available for the workflow should be at /projects/bootcamp/workflow/lib. The process also defines properties queueName, ssh.host, and fileTimestamp which are passed to the workflow. In addition, Falcon exposes the following properties to the workflow: nameNode, jobTracker(hadoop properties), input and output(Input/Output properties).</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h5>Process<a name="Process"></a></h5> +<p>Sample process which runs daily at 6th hour on corp cluster. It takes one input - <a href="./SampleInput.html">SampleInput</a> for the previous day(24 instances). It generates one output - <a href="./SampleOutput.html">SampleOutput</a> for previous day. The workflow is defined at /projects/bootcamp/workflow/workflow.xml. Any libraries available for the workflow should be at /projects/bootcamp/workflow/lib. The process also defines properties queueName, ssh.host, and fileTimestamp which are passed to the workflow. In addition, Falcon exposes the following properties to the workflow: nameNode, jobTracker(hadoop properties), input and output(Input/Output properties).</p> +<div class="source"> +<pre> <?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 @@ -195,7 +233,16 @@ xmlns:xsi="http://www.w3.org/2001/X </late-process> </process> -</pre></div></div><div class="section"><h5>Oozie Workflow<a name="Oozie_Workflow"></a></h5><p>The sample user workflow contains 3 actions:</p><ul><li>Pig action - Executes pig script /projects/bootcamp/workflow/script.pig</li><li>concatenator - Java action that concatenates part files and generates a single file</li><li>file upload - ssh action that gets the concatenated file from hadoop and sends the file to a remote host</li></ul><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h5>Oozie Workflow<a name="Oozie_Workflow"></a></h5> +<p>The sample user workflow contains 3 actions:</p> +<ul> +<li>Pig action - Executes pig script /projects/bootcamp/workflow/script.pig</li> +<li>concatenator - Java action that concatenates part files and generates a single file</li> +<li>file upload - ssh action that gets the concatenated file from hadoop and sends the file to a remote host</li></ul> +<div class="source"> +<pre> <workflow-app xmlns="uri:oozie:workflow:0.2" name="sample-wf"> <start to="pig" /> @@ -274,7 +321,12 @@ xmlns:xsi="http://www.w3.org/2001/X <end name="end" /> </workflow-app> -</pre></div></div><div class="section"><h5>File Upload Script<a name="File_Upload_Script"></a></h5><p>The script gets the file from hadoop, rsyncs the file to /tmp on remote host and deletes the file from hadoop</p><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h5>File Upload Script<a name="File_Upload_Script"></a></h5> +<p>The script gets the file from hadoop, rsyncs the file to /tmp on remote host and deletes the file from hadoop</p> +<div class="source"> +<pre> #!/bin/bash trap 'echo "output=$?"; exit $?' ERR INT TERM @@ -305,7 +357,7 @@ echo "output=0" <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/AdminConfig.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/AdminConfig.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/AdminConfig.html (original) +++ falcon/site/0.3-incubating/docs/restapi/AdminConfig.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/admin/config/:config-type</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,39 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/admin/config/:config-type<a name="GET_apiadminconfig:config-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>Get configuration information of the falcon server.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:config-type can be build, deploy, startup or runtime</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Configuration information of the server.</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 class="prettyprint"> + <div class="section"> +<h3>GET /api/admin/config/:config-type<a name="GET_apiadminconfig:config-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>Get configuration information of the falcon server.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:config-type can be build, deploy, startup or runtime</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Configuration information of the server.</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/admin/config/deploy Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "properties": [ { @@ -96,7 +124,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/AdminStack.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/AdminStack.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/AdminStack.html (original) +++ falcon/site/0.3-incubating/docs/restapi/AdminStack.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/admin/stack</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,37 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/admin/stack<a name="GET_apiadminstack"></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 stack trace of the falcon server.</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>Stack trace of the server.</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 class="prettyprint"> + <div class="section"> +<h3>GET /api/admin/stack<a name="GET_apiadminstack"></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 stack trace of the falcon server.</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>Stack trace of the server.</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/admin/stack Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> Reference Handler State: WAITING java.lang.Object.wait(Native Method) @@ -101,7 +127,7 @@ java.lang.Thread.run(Thread.java:695) <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/AdminVersion.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/AdminVersion.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/AdminVersion.html (original) +++ falcon/site/0.3-incubating/docs/restapi/AdminVersion.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/admin/version</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,37 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/admin/version<a name="GET_apiadminversion"></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 version of the falcon server.</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>Version of the server.</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 class="prettyprint"> + <div class="section"> +<h3>GET /api/admin/version<a name="GET_apiadminversion"></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 version of the falcon server.</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>Version of the server.</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/admin/version Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { Version:"0.4-incubating-SNAPSHOT-rc0f2701549628f2f97746bd024518512c07d5442", Mode:"embedded" @@ -88,7 +114,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntityDefinition.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntityDefinition.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntityDefinition.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntityDefinition.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/entities/definition/:entity-type/:entity-name</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,40 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/entities/definition/:entity-type/:entity-name<a name="GET_apientitiesdefinition:entity-type:entity-name"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Get definition of the entity.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:entity-type can be cluster, feed or process.</li><li>:entity-name is name of the entity.</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Definition of the entity.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>GET /api/entities/definition/:entity-type/:entity-name<a name="GET_apientitiesdefinition:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get definition of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Definition of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> GET http://localhost:15000/api/entities/definition/process/SampleProcess Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <process name="SampleProcess" xmlns="uri:falcon:process:0.1"> <clusters> @@ -112,7 +141,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntityDelete.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntityDelete.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntityDelete.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntityDelete.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - DELETE /api/entities/delete/:entity-type/:entity-name</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,40 @@ <div id="bodyColumn" > - <div class="section"><h3>DELETE /api/entities/delete/:entity-type/:entity-name<a name="DELETE_apientitiesdelete:entity-type:entity-name"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Delete the specified entity.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:entity-type can be feed or process.</li><li>:entity-name is name of the feed or process.</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Results of the delete operation.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>DELETE /api/entities/delete/:entity-type/:entity-name<a name="DELETE_apientitiesdelete:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Delete the specified entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be feed or process.</li> +<li>:entity-name is name of the feed or process.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the delete operation.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n", "message": "falcon\/SampleProcess(cluster) removed successfully\n", @@ -89,7 +118,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntityDependencies.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntityDependencies.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntityDependencies.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntityDependencies.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/entities/dependencies/:entity-type/:entity-name</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,40 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/entities/dependencies/:entity-type/:entity-name<a name="GET_apientitiesdependencies:entity-type:entity-name"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Get dependencies of the entity.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:entity-type can be cluster, feed or process.</li><li>:entity-name is name of the entity.</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Dependenciess of the entity.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>GET /api/entities/dependencies/:entity-type/:entity-name<a name="GET_apientitiesdependencies:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get dependencies of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Dependenciess of the entity.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> GET http://localhost:15000/api/entities/dependencies/process/SampleProcess Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "entity": [ { @@ -100,7 +129,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntityList.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntityList.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntityList.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntityList.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/entities/list/:entity-type</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,39 @@ <div id="bodyColumn" > - <div class="section"><h3>GET /api/entities/list/:entity-type<a name="GET_apientitieslist:entity-type"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Get list of the entities.</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></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>List of the entities.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>GET /api/entities/list/:entity-type<a name="GET_apientitieslist:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get list of the entities.</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></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>List of the entities.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> GET http://localhost:15000/api/entities/list/feed Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "entity": [ { @@ -96,7 +124,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntityResume.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntityResume.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntityResume.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntityResume.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - POST /api/entities/resume/:entity-type/:entity-name</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,40 @@ <div id="bodyColumn" > - <div class="section"><h3>POST /api/entities/resume/:entity-type/:entity-name<a name="POST_apientitiesresume:entity-type:entity-name"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Resume a supended entity.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:entity-type can either be a feed or a process.</li><li>:entity-name is name of the entity.</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Result of the resume command.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>POST /api/entities/resume/:entity-type/:entity-name<a name="POST_apientitiesresume:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Resume a supended entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the resume command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> POST http://localhost:15000/api/entities/resume/process/SampleProcess Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n", "message": "default\/SampleProcess(process) resumed successfully\n", @@ -89,7 +118,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/0.3-incubating/docs/restapi/EntitySchedule.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/restapi/EntitySchedule.html?rev=1660589&r1=1660588&r2=1660589&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/restapi/EntitySchedule.html (original) +++ falcon/site/0.3-incubating/docs/restapi/EntitySchedule.html Wed Feb 18 10:55:56 2015 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at Feb 6, 2014 + | Generated by Apache Maven Doxia at 2015-02-18 | 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="20140206" /> + <meta name="Date-Revision-yyyymmdd" content="20150218" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - POST /api/entities/schedule/:entity-type/:entity-name</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -27,7 +27,7 @@ <div class="container"> <div id="banner"> <div class="pull-left"> - <a href="../../../../index.html" id="bannerLeft"> + <a href="http://falcon.incubator.apache.org/index.html"; id="bannerLeft"> <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> </a> </div> @@ -59,7 +59,7 @@ <li class="divider pull-right">|</li> - <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon"; class="externalLink" title="0.3-incubating"> + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.3-incubating"> 0.3-incubating</a> </li> @@ -70,11 +70,40 @@ <div id="bodyColumn" > - <div class="section"><h3>POST /api/entities/schedule/:entity-type/:entity-name<a name="POST_apientitiesschedule:entity-type:entity-name"></a></h3><p></p><ul><li><a href="#Description">Description</a></li><li><a href="#Parameters">Parameters</a></li><li><a href="#Results">Results</a></li><li><a href="#Examples">Examples</a></li></ul></div><div class="section"><h3>Description<a name="Description"></a></h3><p>Schedule an entity.</p></div><div class="section"><h3>Parameters<a name="Parameters"></a></h3><p></p><ul><li>:entity-type can either be a feed or a process.</li><li>:entity-name is name of the entity.</li></ul></div><div class="section"><h3>Results<a name="Results"></a></h3><p>Result of the schedule command.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3></div><div class="section"><h4>Rest Call<a name="Rest_Call"></a></h4><div class="source"><pre class="prettyprint"> + <div class="section"> +<h3>POST /api/entities/schedule/:entity-type/:entity-name<a name="POST_apientitiesschedule:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Schedule an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can either be a feed or a process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the schedule command.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> POST http://localhost:15000/api/entities/schedule/process/SampleProcess Remote-User: rgautam -</pre></div></div><div class="section"><h4>Result<a name="Result"></a></h4><div class="source"><pre class="prettyprint"> +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> { "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n", "message": "default\/SampleProcess(process) scheduled successfully\n", @@ -89,7 +118,7 @@ Remote-User: rgautam <footer> <div class="container"> - <div class="row span12">Copyright © 2013-2014 + <div class="row span12">Copyright © 2013-2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.
