apidocs/json_RangerServiceDef.html (633 lines of code) (raw):
<!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: RangerServiceDef</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: RangerServiceDef</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_json.html">JSON</a></li>
<li class="dropdown"><a href="json_RangerServiceDef.html">RangerServiceDef</a></li>
</ol>
<h1 class="page-header">RangerServiceDef <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span id="prop-accessTypes" class="property-name">accessTypes</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerAccessTypeDef.html">RangerAccessTypeDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-label" class="property-name">label</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-rbKeyLabel" class="property-name">rbKeyLabel</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-dataMaskDef" class="property-name">dataMaskDef</span>
</td>
<td> <span class="datatype-reference"><a href="json_RangerDataMaskDef.html">RangerDataMaskDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-resources" class="property-name">resources</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerResourceDef.html">RangerResourceDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-options" class="property-name">options</span>
</td>
<td> <span class="datatype-reference">map of string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-rowFilterDef" class="property-name">rowFilterDef</span>
</td>
<td> <span class="datatype-reference"><a href="json_RangerRowFilterDef.html">RangerRowFilterDef</a>
</span>
</td>
<td> <span class="property-description"></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-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-policyConditions" class="property-name">policyConditions</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerPolicyConditionDef.html">RangerPolicyConditionDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-implClass" class="property-name">implClass</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-displayName" class="property-name">displayName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-name" class="property-name">name</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-contextEnrichers" class="property-name">contextEnrichers</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerContextEnricherDef.html">RangerContextEnricherDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-enums" class="property-name">enums</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerEnumDef.html">RangerEnumDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-rbKeyDescription" class="property-name">rbKeyDescription</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span id="prop-configs" class="property-name">configs</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_RangerServiceConfigDef.html">RangerServiceConfigDef</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_RangerBaseModelObject.html">RangerBaseModelObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">createTime</span></td>
<td><span class="datatype-reference">number
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">number
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">updatedBy</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">version</span></td>
<td><span class="datatype-reference">number
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">createdBy</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">guid</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">updateTime</span></td>
<td><span class="datatype-reference">number
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">isEnabled</span></td>
<td><span class="datatype-reference">boolean
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
"accessTypes" : [ {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
}, {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
} ],
"label" : "...",
"rbKeyLabel" : "...",
"dataMaskDef" : {
"maskTypes" : [ {
"itemId" : 12345,
"rbKeyDescription" : "...",
"rbKeyLabel" : "...",
"dataMaskOptions" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"transformer" : "...",
"name" : "...",
"label" : "..."
}, {
"itemId" : 12345,
"rbKeyDescription" : "...",
"rbKeyLabel" : "...",
"dataMaskOptions" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"transformer" : "...",
"name" : "...",
"label" : "..."
} ],
"accessTypes" : [ {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
}, {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
} ],
"resources" : [ {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
}, {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
} ]
},
"resources" : [ {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
}, {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
} ],
"options" : {
"property1" : "...",
"property2" : "..."
},
"rowFilterDef" : {
"accessTypes" : [ {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
}, {
"impliedGrants" : [ "...", "..." ],
"name" : "...",
"label" : "...",
"itemId" : 12345,
"rbKeyLabel" : "..."
} ],
"resources" : [ {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
}, {
"recursiveSupported" : true,
"label" : "...",
"excludesSupported" : true,
"parent" : "...",
"matcher" : "...",
"type" : "...",
"accessTypeRestrictions" : [ "...", "..." ],
"lookupSupported" : true,
"isValidLeaf" : true,
"matcherOptions" : {
"property1" : "...",
"property2" : "..."
},
"name" : "...",
"rbKeyLabel" : "...",
"mandatory" : true,
"validationMessage" : "...",
"level" : 12345,
"itemId" : 12345,
"uiHint" : "...",
"rbKeyValidationMessage" : "...",
"description" : "...",
"validationRegEx" : "...",
"rbKeyDescription" : "..."
} ]
},
"description" : "...",
"policyConditions" : [ {
"uiHint" : "...",
"description" : "...",
"itemId" : 12345,
"name" : "...",
"validationRegEx" : "...",
"label" : "...",
"rbKeyLabel" : "...",
"evaluatorOptions" : {
"property1" : "...",
"property2" : "..."
},
"validationMessage" : "...",
"evaluator" : "...",
"rbKeyValidationMessage" : "...",
"rbKeyDescription" : "..."
}, {
"uiHint" : "...",
"description" : "...",
"itemId" : 12345,
"name" : "...",
"validationRegEx" : "...",
"label" : "...",
"rbKeyLabel" : "...",
"evaluatorOptions" : {
"property1" : "...",
"property2" : "..."
},
"validationMessage" : "...",
"evaluator" : "...",
"rbKeyValidationMessage" : "...",
"rbKeyDescription" : "..."
} ],
"implClass" : "...",
"displayName" : "...",
"name" : "...",
"contextEnrichers" : [ {
"name" : "...",
"itemId" : 12345,
"enricherOptions" : {
"property1" : "...",
"property2" : "..."
},
"enricher" : "..."
}, {
"name" : "...",
"itemId" : 12345,
"enricherOptions" : {
"property1" : "...",
"property2" : "..."
},
"enricher" : "..."
} ],
"enums" : [ {
"name" : "...",
"defaultIndex" : 12345,
"elements" : [ {
"itemId" : 12345,
"label" : "...",
"rbKeyLabel" : "...",
"name" : "..."
}, {
"itemId" : 12345,
"label" : "...",
"rbKeyLabel" : "...",
"name" : "..."
} ],
"itemId" : 12345
}, {
"name" : "...",
"defaultIndex" : 12345,
"elements" : [ {
"itemId" : 12345,
"label" : "...",
"rbKeyLabel" : "...",
"name" : "..."
}, {
"itemId" : 12345,
"label" : "...",
"rbKeyLabel" : "...",
"name" : "..."
} ],
"itemId" : 12345
} ],
"rbKeyDescription" : "...",
"configs" : [ {
"rbKeyDescription" : "...",
"subType" : "...",
"rbKeyLabel" : "...",
"defaultValue" : "...",
"rbKeyValidationMessage" : "...",
"label" : "...",
"name" : "...",
"description" : "...",
"itemId" : 12345,
"mandatory" : true,
"validationRegEx" : "...",
"validationMessage" : "...",
"type" : "...",
"uiHint" : "..."
}, {
"rbKeyDescription" : "...",
"subType" : "...",
"rbKeyLabel" : "...",
"defaultValue" : "...",
"rbKeyValidationMessage" : "...",
"label" : "...",
"name" : "...",
"description" : "...",
"itemId" : 12345,
"mandatory" : true,
"validationRegEx" : "...",
"validationMessage" : "...",
"type" : "...",
"uiHint" : "..."
} ],
"createTime" : 12345,
"id" : 12345,
"updatedBy" : "...",
"version" : 12345,
"createdBy" : "...",
"guid" : "...",
"updateTime" : 12345,
"isEnabled" : true
}</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>