Google Git
Sign in
apache / ranger-site / a2400e1b7e0fd42bd870c26f2842c001ce98deea / . / apidocs / xml_ns0_VXPolicy.html
blob: 95fda89f04e382467eb609b77680f2bd740d98a7 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>Ranger REST API: VXPolicy</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Ranger REST API: VXPolicy</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_xml.html">XML</a></li>
<li class="dropdown"><a href="xml_ns0_VXPolicy.html">VXPolicy</a></li>
</ol>
<h1 class="page-header">VXPolicy <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
<dt>Namespace</dt>
<dd>(Default)</dd>
<dt>Schema</dt>
<dd><a href="ns0.xsd">ns0.xsd</a></dd>
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>type</th>
<th>namespace</th>
<th>min/max occurs</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span id="prop-columnFamilies" class="property-name">columnFamilies</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>columnFamilies</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-columnType" class="property-name">columnType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>columnType</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-columns" class="property-name">columns</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>columns</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-databases" class="property-name">databases</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>databases</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-description" class="property-name">description</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>description</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-grantor" class="property-name">grantor</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">&nbsp;</span>
</td>
</tr>
<tr>
<td> <span id="prop-hiveServices" class="property-name">hiveServices</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>hiveservices</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-isAuditEnabled" class="property-name">isAuditEnabled</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">1/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>isAuditEnabled</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-isEnabled" class="property-name">isEnabled</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">1/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>isEnable</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-isRecursive" class="property-name">isRecursive</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>isRecursive</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-permMapList" class="property-name">permMapList</span>
</td>
<td> <span class="datatype-reference">list of <a href="xml_ns0_VXPermObj.html">VXPermObj</a>
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>userPermList</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-policyLabel" class="property-name">policyLabel</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">&nbsp;</span>
</td>
</tr>
<tr>
<td> <span id="prop-policyName" class="property-name">policyName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>policyName</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-replacePerm" class="property-name">replacePerm</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">1/1
</span>
</td>
<td> <span class="property-description">&nbsp;</span>
</td>
</tr>
<tr>
<td> <span id="prop-repositoryName" class="property-name">repositoryName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>repositoryName</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-repositoryType" class="property-name">repositoryType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>repositoryType</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-resourceName" class="property-name">resourceName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>resourceName</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-services" class="property-name">services</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>services</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-tableType" class="property-name">tableType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>tableType</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-tables" class="property-name">tables</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>tables</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-topologies" class="property-name">topologies</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>topologies</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-udfs" class="property-name">udfs</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>udfs</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-version" class="property-name">version</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>version</b></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_VXDataObject.html">VXDataObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">createDate</span></td>
<td><span class="datatype-reference">dateTime
</span></td>
<td><span class="property-type">element
</span></td>
<td><span class="property-namespaceInfo">
</span></td>
<td><span class="property-minMaxOccurs">0/1
</span></td>
<td><span class="property-description">Returns the value for the member attribute <b>createDate</b></span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">long
</span></td>
<td><span class="property-type">element
</span></td>
<td><span class="property-namespaceInfo">
</span></td>
<td><span class="property-minMaxOccurs">0/1
</span></td>
<td><span class="property-description">Returns the value for the member attribute <b>id</b></span></td>
</tr>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-type">element
</span></td>
<td><span class="property-namespaceInfo">
</span></td>
<td><span class="property-minMaxOccurs">0/1
</span></td>
<td><span class="property-description">Returns the value for the member attribute <b>owner</b></span></td>
</tr>
<tr>
<td><span class="property-name">updateDate</span></td>
<td><span class="datatype-reference">dateTime
</span></td>
<td><span class="property-type">element
</span></td>
<td><span class="property-namespaceInfo">
</span></td>
<td><span class="property-minMaxOccurs">0/1
</span></td>
<td><span class="property-description">Returns the value for the member attribute <b>updateDate</b></span></td>
</tr>
<tr>
<td><span class="property-name">updatedBy</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-type">element
</span></td>
<td><span class="property-namespaceInfo">
</span></td>
<td><span class="property-minMaxOccurs">0/1
</span></td>
<td><span class="property-description">Returns the value for the member attribute <b>updatedBy</b></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-xml example">&lt;VXPolicy&gt;
&lt;policyName&gt;...&lt;/policyName&gt;
&lt;resourceName&gt;...&lt;/resourceName&gt;
&lt;description&gt;...&lt;/description&gt;
&lt;repositoryName&gt;...&lt;/repositoryName&gt;
&lt;repositoryType&gt;...&lt;/repositoryType&gt;
&lt;permMapList&gt;
&lt;userList&gt;...&lt;/userList&gt;
&lt;groupList&gt;...&lt;/groupList&gt;
&lt;permList&gt;...&lt;/permList&gt;
&lt;ipAddress&gt;...&lt;/ipAddress&gt;
&lt;/permMapList&gt;
&lt;tables&gt;...&lt;/tables&gt;
&lt;columnFamilies&gt;...&lt;/columnFamilies&gt;
&lt;columns&gt;...&lt;/columns&gt;
&lt;databases&gt;...&lt;/databases&gt;
&lt;udfs&gt;...&lt;/udfs&gt;
&lt;tableType&gt;...&lt;/tableType&gt;
&lt;columnType&gt;...&lt;/columnType&gt;
&lt;topologies&gt;...&lt;/topologies&gt;
&lt;services&gt;...&lt;/services&gt;
&lt;hiveServices&gt;...&lt;/hiveServices&gt;
&lt;isEnabled&gt;...&lt;/isEnabled&gt;
&lt;isRecursive&gt;...&lt;/isRecursive&gt;
&lt;isAuditEnabled&gt;...&lt;/isAuditEnabled&gt;
&lt;version&gt;...&lt;/version&gt;
&lt;grantor&gt;...&lt;/grantor&gt;
&lt;replacePerm&gt;...&lt;/replacePerm&gt;
&lt;policyLabel&gt;...&lt;/policyLabel&gt;
&lt;id&gt;...&lt;/id&gt;
&lt;createDate&gt;...&lt;/createDate&gt;
&lt;updateDate&gt;...&lt;/updateDate&gt;
&lt;owner&gt;...&lt;/owner&gt;
&lt;updatedBy&gt;...&lt;/updatedBy&gt;
&lt;/VXPolicy&gt;
</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>