Google Git
Sign in
apache / falcon / refs/heads/asf-site / . / content / 0.11 / restapi / EntityValidate.html
blob: 2d368ecd40ffc8e8b8210d5174a2afd2bf5951d8 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2018-03-12
| 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="20180312" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - POST api/entities/validate/entity-type</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
<link rel="stylesheet" href="../css/site.css" />
<link rel="stylesheet" href="../css/print.css" media="print" />
<script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
</head>
<body class="topBarDisabled">
<div class="container">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="../index.html" title="Falcon">
Falcon</a>
</li>
<li class="divider ">/</li>
<li class="">POST api/entities/validate/entity-type</li>
<li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li>
<li id="projectVersion" class="pull-right">Version: 0.11</li>
</ul>
</div>
<div id="bodyColumn" >
<div class="section">
<h3>POST api/entities/validate/entity-type<a name="POST__apientitiesvalidateentity-type"></a></h3>
<p></p>
<ul>
<li><a href="#Description">Description</a></li>
<li><a href="#Parameters">Parameters</a></li>
<li><a href="#Results">Results</a></li>
<li><a href="#Examples">Examples</a></li></ul></div>
<div class="section">
<h3>Description<a name="Description"></a></h3>
<p>Validates the submitted entity.</p></div>
<div class="section">
<h3>Parameters<a name="Parameters"></a></h3>
<p></p>
<ul>
<li>:entity-type can be cluster, feed or process.</li>
<li>skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.</li>
<li>doAs &lt;optional query param&gt; allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Result of the validation.</p></div>
<div class="section">
<h3>Examples<a name="Examples"></a></h3></div>
<div class="section">
<h4>Rest Call<a name="Rest_Call"></a></h4>
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/cluster
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;cluster xmlns=&quot;uri:falcon:cluster:0.1&quot; name=&quot;primary-cluster&quot; description=&quot;Primary Cluster&quot; colo=&quot;west-coast&quot;&gt;
&lt;interfaces&gt;
&lt;interface type=&quot;readonly&quot; endpoint=&quot;hftp://localhost:50070&quot; version=&quot;1.1.1&quot;/&gt;
&lt;interface type=&quot;write&quot; endpoint=&quot;hdfs://localhost:9000&quot; version=&quot;1.1.1&quot;/&gt;
&lt;interface type=&quot;execute&quot; endpoint=&quot;localhost:9001&quot; version=&quot;1.1.1&quot;/&gt;
&lt;interface type=&quot;workflow&quot; endpoint=&quot;http://localhost:11000/oozie/&quot; version=&quot;4.0.0&quot;/&gt;
&lt;interface type=&quot;messaging&quot; endpoint=&quot;tcp://localhost:61616?daemon=true&quot; version=&quot;5.4.3&quot;/&gt;
&lt;/interfaces&gt;
&lt;locations&gt;
&lt;location name=&quot;staging&quot; path=&quot;/apps/falcon/staging&quot;/&gt;
&lt;location name=&quot;temp&quot; path=&quot;/tmp&quot;/&gt;
&lt;location name=&quot;working&quot; path=&quot;/apps/falcon/working&quot;/&gt;
&lt;/locations&gt;
&lt;/cluster&gt;
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;requestId&quot;: &quot;dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10&quot;,
&quot;message&quot;: &quot;Validated successfully (CLUSTER) primary-cluster&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</pre></div></div>
<div class="section">
<h4>Rest Call<a name="Rest_Call"></a></h4>
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/feed?skipDryRun=true
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!-- Hourly sample input data --&gt;
&lt;feed description=&quot;sample input data&quot;
name=&quot;SampleInput&quot; xmlns=&quot;uri:falcon:feed:0.1&quot;
xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;
&lt;groups&gt;group&lt;/groups&gt;
&lt;frequency&gt;hours(1)&lt;/frequency&gt;
&lt;late-arrival cut-off=&quot;hours(6)&quot; /&gt;
&lt;clusters&gt;
&lt;cluster name=&quot;primary-cluster&quot; type=&quot;source&quot;&gt;
&lt;!--validity start=&quot;2009-01-01T00:00Z&quot; end=&quot;2099-12-31T00:00Z&quot; timezone=&quot;UTC&quot; /--&gt;
&lt;validity start=&quot;2009-01-01T00:00Z&quot; end=&quot;2099-12-31T00:00Z&quot; /&gt;
&lt;retention limit=&quot;months(24)&quot; action=&quot;delete&quot; /&gt;
&lt;/cluster&gt;
&lt;/clusters&gt;
&lt;locations&gt;
&lt;location type=&quot;data&quot; path=&quot;/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput&quot; /&gt;
&lt;location type=&quot;stats&quot; path=&quot;/projects/bootcamp/stats/SampleInput&quot; /&gt;
&lt;location type=&quot;meta&quot; path=&quot;/projects/bootcamp/meta/SampleInput&quot; /&gt;
&lt;/locations&gt;
&lt;ACL owner=&quot;suser&quot; group=&quot;users&quot; permission=&quot;0755&quot; /&gt;
&lt;schema location=&quot;/none&quot; provider=&quot;none&quot; /&gt;
&lt;/feed&gt;
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;requestId&quot;: &quot;c85b190e-e653-493a-a863-d62de9c2e3b0&quot;,
&quot;message&quot;: &quot;Validated successfully (FEED) SampleInput&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</pre></div></div>
<div class="section">
<h4>Rest Call<a name="Rest_Call"></a></h4>
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/feed
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!-- Daily sample output data --&gt;
&lt;feed description=&quot;sample output data&quot; name=&quot;SampleOutput&quot; xmlns=&quot;uri:falcon:feed:0.1&quot;
xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;
&lt;groups&gt;group&lt;/groups&gt;
&lt;frequency&gt;hours(1)&lt;/frequency&gt;
&lt;late-arrival cut-off=&quot;hours(6)&quot; /&gt;
&lt;clusters&gt;
&lt;cluster name=&quot;primary-cluster&quot; type=&quot;source&quot;&gt;
&lt;!--validity start=&quot;2009-01-01T00:00Z&quot; end=&quot;2099-12-31T00:00Z&quot; timezone=&quot;UTC&quot; /--&gt;
&lt;validity start=&quot;2009-01-01T00:00Z&quot; end=&quot;2099-12-31T00:00Z&quot; /&gt;
&lt;retention limit=&quot;months(24)&quot; action=&quot;delete&quot; /&gt;
&lt;/cluster&gt;
&lt;/clusters&gt;
&lt;locations&gt;
&lt;location type=&quot;data&quot; path=&quot;/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput&quot; /&gt;
&lt;location type=&quot;stats&quot; path=&quot;/projects/bootcamp/stats/SampleOutput&quot; /&gt;
&lt;location type=&quot;meta&quot; path=&quot;/projects/bootcamp/meta/SampleOutput&quot; /&gt;
&lt;/locations&gt;
&lt;ACL owner=&quot;suser&quot; group=&quot;users&quot; permission=&quot;0755&quot; /&gt;
&lt;schema location=&quot;/none&quot; provider=&quot;none&quot; /&gt;
&lt;/feed&gt;
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;requestId&quot;: &quot;60781732-460e-4c6c-ba86-a75fae574b05&quot;,
&quot;message&quot;: &quot;Validated successfully (FEED) SampleOutput&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</pre></div></div>
<div class="section">
<h4>Rest Call<a name="Rest_Call"></a></h4>
<div class="source">
<pre>
POST http://localhost:15000/api/entities/validate/process?skipDryRun=false&amp;doAs=joe
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday --&gt;
&lt;process xmlns=&quot;uri:falcon:process:0.1&quot; name=&quot;SampleProcess&quot; &gt;
&lt;clusters&gt;
&lt;cluster name=&quot;primary-cluster&quot;&gt;
&lt;validity start=&quot;2012-04-03T06:00Z&quot; end=&quot;2022-12-30T00:00Z&quot; /&gt;
&lt;/cluster&gt;
&lt;/clusters&gt;
&lt;parallel&gt;1&lt;/parallel&gt;
&lt;order&gt;FIFO&lt;/order&gt;
&lt;frequency&gt;hours(1)&lt;/frequency&gt;
&lt;inputs&gt;
&lt;input name=&quot;input&quot; feed=&quot;SampleInput&quot; start=&quot;yesterday(0,0)&quot; end=&quot;today(-1,0)&quot; /&gt;
&lt;/inputs&gt;
&lt;outputs&gt;
&lt;output name=&quot;output&quot; feed=&quot;SampleOutput&quot; instance=&quot;yesterday(0,0)&quot; /&gt;
&lt;/outputs&gt;
&lt;properties&gt;
&lt;property name=&quot;queueName&quot; value=&quot;default&quot; /&gt;
&lt;property name=&quot;ssh.host&quot; value=&quot;localhost&quot; /&gt;
&lt;property name=&quot;fileTimestamp&quot; value=&quot;${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}&quot; /&gt;
&lt;/properties&gt;
&lt;workflow engine=&quot;oozie&quot; path=&quot;/examples/apps/aggregator&quot; /&gt;
&lt;retry policy=&quot;exp-backoff&quot; delay=&quot;minutes(5)&quot; attempts=&quot;3&quot; /&gt;
&lt;late-process policy=&quot;exp-backoff&quot; delay=&quot;hours(1)&quot;&gt;
&lt;late-input input=&quot;input&quot; workflow-path=&quot;/projects/bootcamp/workflow/lateinput&quot; /&gt;
&lt;/late-process&gt;
&lt;/process&gt;
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;requestId&quot;: &quot;e4a965c6-c7a2-41d9-ba08-2e77f1c43f57&quot;,
&quot;message&quot;: &quot;Validated successfully (PROCESS) SampleProcess&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</pre></div></div>
</div>
</div>
<hr/>
<footer>
<div class="container">
<div class="row span12">Copyright &copy; 2013-2018
<a href="http://www.apache.org">Apache Software Foundation</a>.
All Rights Reserved.
</div>
<p id="poweredBy" class="pull-right">
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
</a>
</p>
</div>
</footer>
</body>
</html>