http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/css/enunciate.css ---------------------------------------------------------------------- diff --git a/1.0.0-rc0/api/v2/css/enunciate.css b/1.0.0-rc0/api/v2/css/enunciate.css new file mode 100644 index 0000000..140d3b3 --- /dev/null +++ b/1.0.0-rc0/api/v2/css/enunciate.css @@ -0,0 +1,122 @@ +/* + * Base structure + */ + +/* Move down content because we have a fixed navbar that is 50px tall */ +body { + position:relative; + padding-top: 50px; +} + +.footer { + width: 100%; + /* Set the fixed height of the footer here */ + height: 60px; + background-color: #f5f5f5; +} + +/* + * Global add-ons + */ +.sub-header { + padding-bottom: 10px; + border-bottom: 1px solid #eee; +} + +/* + * Sidebar + */ + +/* Hide for mobile, show later */ +.sidebar { + display: none; +} +@media (min-width: 768px) { + .sidebar { + position: fixed; + top: 51px; + bottom: 0; + left: 0; + z-index: 1000; + display: block; + padding: 20px; + overflow-x: hidden; + overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ + background-color: #f5f5f5; + border-right: 1px solid #eee; + } +} + +/* Sidebar navigation */ +.nav-sidebar { + margin-right: -21px; /* 20px padding + 1px border */ + margin-bottom: 20px; + margin-left: -20px; +} +.nav-sidebar > li > a { + padding-right: 20px; + padding-left: 20px; +} +.sideoverflow { + display: block; + text-overflow: ellipsis; + white-space: nowrap; + overflow: hidden; + max-width:100%; +} +.nav-sidebar > .active > a, +.nav-sidebar > .active > a:hover, +.nav-sidebar > .active > a:focus { + color: #fff; + background-color: #428bca; +} + +/* + * Main content + */ +.main { + padding: 20px; +} +@media (min-width: 768px) { + .main { + padding-right: 40px; + padding-left: 40px; + } +} +.main .page-header { + margin-top: 0; +} +.footer > .container { + padding-top: 20px; + text-align: center; +} + +/* + * Row Links + */ +.table.rowlink td:not(.rowlink-skip), +.table .rowlink td:not(.rowlink-skip) { + cursor: pointer; +} +.table.rowlink td:not(.rowlink-skip) a, +.table .rowlink td:not(.rowlink-skip) a { + font: inherit; + color: inherit; + text-decoration: inherit; +} +.multi-row-description { + border-left: 1px solid #DDD; +} + +pre { + max-height: 40em; +} + +/* shift the anchors to accommodate fixed navbar. See https://github.com/twbs/bootstrap/issues/1768#issuecomment-46519033 */ +*[id]:before { + display: block; + content: " "; + margin-top: -70px; + height: 70px; + visibility: hidden; +}
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/data.html ---------------------------------------------------------------------- diff --git a/1.0.0-rc0/api/v2/data.html b/1.0.0-rc0/api/v2/data.html new file mode 100644 index 0000000..cab2ae4 --- /dev/null +++ b/1.0.0-rc0/api/v2/data.html @@ -0,0 +1,426 @@ +<!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>Apache Atlas Web Application: Data Types</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">Apache Atlas Web Application: Data Types</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> + <li><a href="downloads.html">Files and Libraries</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><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</span></abbr></a></li> + <li class="divider"></li> + <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="dropdown"><a href="data.html">Data Types</a></li> + </ol> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json">JSON</h3> + + <table class="table table-hover data-types"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedObjectId.html"> + <td> <span class="datatype-name">AtlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">AtlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">AtlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_json">JSON</h3> + + <table class="table table-hover data-types"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedObjectId.html"> + <td> <span class="datatype-name">AtlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">AtlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">AtlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml">XML</h3> + + <table class="table table-hover data-types"> + <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="xml_ns0_timeBoundary.html"> + <td> <span class="datatype-name">timeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">atlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">atlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> + <td> <span class="datatype-name">atlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasEntity.html"> + <td> <span class="datatype-name">atlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_status.html"> + <td> <span class="datatype-name">status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasEntityHeader.html"> + <td> <span class="datatype-name">atlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasObjectId.html"> + <td> <span class="datatype-name">atlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasRelatedObjectId.html"> + <td> <span class="datatype-name">atlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasRelationship.html"> + <td> <span class="datatype-name">atlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> + <td> <span class="datatype-name">atlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_propagateTags.html"> + <td> <span class="datatype-name">propagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + </tbody> + </table> + + <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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/downloads.html ---------------------------------------------------------------------- diff --git a/1.0.0-rc0/api/v2/downloads.html b/1.0.0-rc0/api/v2/downloads.html new file mode 100644 index 0000000..b0290c4 --- /dev/null +++ b/1.0.0-rc0/api/v2/downloads.html @@ -0,0 +1,665 @@ +<!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>Apache Atlas Web Application: Files and Libraries</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">Apache Atlas Web Application: Files and Libraries</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> + <li><a href="downloads.html">Files and Libraries</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><a href="#artifact_gwt_json_overlay"><abbr title="GWT JSON Overlay"><span class="sideoverflow">GWT JSON Overlay</span></abbr></a></li> + <li><a href="#artifact_java_json_client_library"><abbr title="Java JSON Client Library"><span class="sideoverflow">Java JSON Client Library</span></abbr></a></li> + <li><a href="#artifact_java_xml_client_library"><abbr title="Java XML Client Library"><span class="sideoverflow">Java XML Client Library</span></abbr></a></li> + <li><a href="#artifact_js_client_library"><abbr title="JavaScript Client Library"><span class="sideoverflow">JavaScript Client Library</span></abbr></a></li> + <li><a href="#artifact_ns0_xsd"><abbr title="ns0.xsd"><span class="sideoverflow">ns0.xsd</span></abbr></a></li> + <li><a href="#artifact_php_json_client_library"><abbr title="PHP JSON Client Library"><span class="sideoverflow">PHP JSON Client Library</span></abbr></a></li> + <li><a href="#artifact_php_xml_client_library"><abbr title="PHP XML Client Library"><span class="sideoverflow">PHP XML Client Library</span></abbr></a></li> + <li><a href="#artifact_ruby_json_client_library"><abbr title="Ruby JSON Client Library"><span class="sideoverflow">Ruby JSON Client Library</span></abbr></a></li> + <li class="divider"></li> + <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="dropdown"><a href="downloads.html">Files and Libraries</a></li> + </ol> + + <h1 class="page-header">Files and Libraries</h1> + + <h3 id="artifact_gwt_json_overlay">GWT JSON Overlay</h3> + <p class="lead">Created May 26, 2018</p> + <p> <p> + The <a href="http://code.google.com/webtoolkit/";>Google Web Toolkit</a> JSON Overlay library provides the JSON Overlays that + can be used to access the Web service API for this application. + </p> + + +<div class="panel panel-default"> + <div class="panel-heading">JSON Overlay Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-java"> +String url = ...; +RequestBuilder request = new RequestBuilder(RequestBuilder.GET, url); +request.sendRequest(null, new RequestCallback() { + public void onResponseReceived(Request request, Response response) { + if (200 == response.getStatusCode()) { + //handle the successful data... + JavaScriptObject data = JavaScriptObject.fromJson(response.getText()); + //handle the JavaScriptObject... + } + else { + //handle the error... + } + } + + public void onError(Request request, Throwable throwable) { + //handle the error... + } +}); + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-gwt-json-overlay.jar"> + <td><span class="downloadfile-name">atlas-webapp-gwt-json-overlay.jar</span></td> + <td><span class="downloadfile-size">10.39K</span></td> + <td><span class="downloadfile-description">The sources for the GWT JSON overlay.</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_java_json_client_library">Java JSON Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The Java client-side library is used to provide the set of Java objects that can be serialized + to/from JSON using <a href="http://jackson.codehaus.org/";>Jackson</a>. This is useful for accessing the + JSON REST endpoints that are published by this application. +</p> + +<div class="panel panel-default"> + <div class="panel-heading">Resources Example (Raw JAXB)</div> + <div class="panel-body"> + <pre class="prettyprint lang-java"> +java.net.URL url = new java.net.URL(baseURL + "/admin/export"); +ObjectMapper mapper = new ObjectMapper(); +java.net.URLConnection connection = url.openConnection(); +connection.setDoOutput(true); +connection.connect(); + +mapper.writeValue(connection.getOutputStream(), object); +Object result = (Object) mapper.readValue( connection.getInputStream(), Object.class ); +//handle the result as needed... + </pre> + </div> +</div> + +<div class="panel panel-default"> + <div class="panel-heading">Resources Example (Jersey client)</div> + <div class="panel-body"> + <pre class="prettyprint lang-java"> +javax.ws.rs.client.Client client = javax.ws.rs.client.ClientBuilder.newClient(); + +Object result = client.target(baseUrl + "/admin/export") + .post(javax.ws.rs.client.Entity.entity(object, "application/json;charset=UTF-8"), Object.class); + +//handle the result as needed... + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-json-client.jar"> + <td><span class="downloadfile-name">atlas-webapp-json-client.jar</span></td> + <td><span class="downloadfile-size">13.04K</span></td> + <td><span class="downloadfile-description">The binaries for the Java JSON client library.</span></td> + </tr> + <tr class="clickable-row" data-href="atlas-webapp-json-client-json-sources.jar"> + <td><span class="downloadfile-name">atlas-webapp-json-client-json-sources.jar</span></td> + <td><span class="downloadfile-size">9.79K</span></td> + <td><span class="downloadfile-description">The sources for the Java JSON client library.</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_java_xml_client_library">Java XML Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The Java client-side library is used to access the Web service API for this application using Java. +</p> + +<p> + The Java client-side library is used to provide the set of Java objects that can be serialized + to/from XML using <a href="https://jaxb.dev.java.net/";>JAXB</a>. This is useful for accessing the + resources that are published by this application. +</p> + +<div class="panel panel-default"> + <div class="panel-heading">Resources Example (Raw JAXB)</div> + <div class="panel-body"> + <pre class="prettyprint lang-java"> +java.net.URL url = new java.net.URL(baseURL + "/admin/export"); +JAXBContext context = JAXBContext.newInstance( byte[].class, byte[].class ); +java.net.URLConnection connection = url.openConnection(); +connection.setDoOutput(true); +connection.connect(); + +Unmarshaller unmarshaller = context.createUnmarshaller(); +Marshaller marshaller = context.createMarshaller(); +marshaller.marshal(object, connection.getOutputStream()); +Object result = (Object) unmarshaller.unmarshal( connection.getInputStream() ); +//handle the result as needed... + </pre> + </div> +</div> + +<div class="panel panel-default"> + <div class="panel-heading">Resources Example (Jersey client)</div> + <div class="panel-body"> + <pre class="prettyprint lang-java"> +javax.ws.rs.client.Client client = javax.ws.rs.client.ClientBuilder.newClient(); + +Object result = client.target(baseUrl + "/admin/export") + .post(javax.ws.rs.client.Entity.entity(object, "application/xml"), Object.class); + +//handle the result as needed... + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-xml-client.jar"> + <td><span class="downloadfile-name">atlas-webapp-xml-client.jar</span></td> + <td><span class="downloadfile-size">13.45K</span></td> + <td><span class="downloadfile-description">The binaries for the Java XML client library.</span></td> + </tr> + <tr class="clickable-row" data-href="atlas-webapp-xml-client-xml-sources.jar"> + <td><span class="downloadfile-name">atlas-webapp-xml-client-xml-sources.jar</span></td> + <td><span class="downloadfile-size">10.95K</span></td> + <td><span class="downloadfile-description">The sources for the Java XML client library.</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_js_client_library">JavaScript Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The JavaScript client-side library defines classes that can be (de)serialized to/from JSON. + This is useful for accessing the resources that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> +<p> + The library uses ES6 class syntax which has limited support. See + <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Browser_compatibility";>MDN</a> + and the <a href="https://kangax.github.io/compat-table/es6/";>ES6 Compatibility Table</a> + for more details. +</p> +<p> + The library contains a UMD loader which supports AMD, CommonJS and browser globals. + The browser global variable name for this library is "javascriptClient". +</p> + +<div class="panel panel-default"> + <div class="panel-heading">JavaScript Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-js"> +//read the resource in JSON: +var json = JSON.parse(jsonString); + +//create an object +var object = new Object(json); + +//retreive the json again +var newJson = object.toJSON(); + +//serialize the json +var newJsonString = JSON.stringify(newJson); + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-js.zip"> + <td><span class="downloadfile-name">atlas-webapp-js.zip</span></td> + <td><span class="downloadfile-size">6.02K</span></td> + <td><span class="downloadfile-description"><p> + The JavaScript client-side library defines classes that can be (de)serialized to/from JSON. + This is useful for accessing the resources that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> +<p> + The library uses ES6 class syntax which has limited support. See + <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Browser_compatibility";>MDN</a> + and the <a href="https://kangax.github.io/compat-table/es6/";>ES6 Compatibility Table</a> + for more details. +</p> +<p> + The library contains a UMD loader which supports AMD, CommonJS and browser globals. + The browser global variable name for this library is "javascriptClient". +</p> + +<div class="panel panel-default"> + <div class="panel-heading">JavaScript Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-js"> +//read the resource in JSON: +var json = JSON.parse(jsonString); + +//create an object +var object = new Object(json); + +//retreive the json again +var newJson = object.toJSON(); + +//serialize the json +var newJsonString = JSON.stringify(newJson); + </pre> + </div> +</div> +</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_ns0_xsd">ns0.xsd</h3> + <p class="lead">Created May 26, 2018</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="ns0.xsd"> + <td><span class="downloadfile-name">ns0.xsd</span></td> + <td><span class="downloadfile-size">12.20K</span></td> + <td><span class="downloadfile-description"> </span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_php_json_client_library">PHP JSON Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The PHP JSON client-side library defines the PHP classes that can be (de)serialized to/from JSON. + This is useful for accessing the resources that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> + +<p> + This library requires the <a href="http://php.net/manual/en/function.json-encode.php";>json_encode</a> function which was included in PHP versions 5.2.0+. +</p> + +<div class="panel panel-default"> + <div class="panel-heading">PHP JSON Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-php"> +//read the resource in JSON: +$json = ...; + +//read the json as an array. +$parsed = json_decode($json, true); + +//read the json array as the object +$result = new Object($parsed); + +//open a writer for the json +$json = $result->toJson(); + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-php.zip"> + <td><span class="downloadfile-name">atlas-webapp-php.zip</span></td> + <td><span class="downloadfile-size">7.19K</span></td> + <td><span class="downloadfile-description"><p> + The PHP JSON client-side library defines the PHP classes that can be (de)serialized to/from JSON. + This is useful for accessing the resources that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> + +<p> + This library requires the <a href="http://php.net/manual/en/function.json-encode.php";>json_encode</a> function which was included in PHP versions 5.2.0+. +</p> + +<div class="panel panel-default"> + <div class="panel-heading">PHP JSON Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-php"> +//read the resource in JSON: +$json = ...; + +//read the json as an array. +$parsed = json_decode($json, true); + +//read the json array as the object +$result = new Object($parsed); + +//open a writer for the json +$json = $result->toJson(); + </pre> + </div> +</div> +</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_php_xml_client_library">PHP XML Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The PHP client-side library defines the PHP classes that can be (de)serialized to/from XML. + This is useful for accessing the resources that are published by this application, but only + those that produce a XML representation of their resources. +</p> + +<p> + This library leverages the <a href="http://php.net/manual/en/book.xmlreader.php";>XMLReader</a> and + <a href="http://php.net/manual/en/book.xmlwriter.php";>XMLWriter</a> tools that were included in PHP + versions 5.1.0+. +</p> + + +<div class="panel panel-default"> + <div class="panel-heading">PHP XML Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-php"> +//read the resource in XML form: +$xml = ...; + +$reader = new \XMLReader(); + +if (!$reader->open($xml)) { + throw new \Exception('Unable to open ' . $xml); +} +$result = new Object($reader); + +//open a writer for the xml +$out = ...; +$writer = new \XMLWriter(); +$writer->openUri($out); +$writer->startDocument(); +$writer->setIndent(4); +$result->toXml($writer); +$writer->flush(); + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp-php.zip"> + <td><span class="downloadfile-name">atlas-webapp-php.zip</span></td> + <td><span class="downloadfile-size">5.04K</span></td> + <td><span class="downloadfile-description"><p> + The PHP client-side library defines the PHP classes that can be (de)serialized to/from XML. + This is useful for accessing the resources that are published by this application, but only + those that produce a XML representation of their resources. +</p> + +<p> + This library leverages the <a href="http://php.net/manual/en/book.xmlreader.php";>XMLReader</a> and + <a href="http://php.net/manual/en/book.xmlwriter.php";>XMLWriter</a> tools that were included in PHP + versions 5.1.0+. +</p> + + +<div class="panel panel-default"> + <div class="panel-heading">PHP XML Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-php"> +//read the resource in XML form: +$xml = ...; + +$reader = new \XMLReader(); + +if (!$reader->open($xml)) { + throw new \Exception('Unable to open ' . $xml); +} +$result = new Object($reader); + +//open a writer for the xml +$out = ...; +$writer = new \XMLWriter(); +$writer->openUri($out); +$writer->startDocument(); +$writer->setIndent(4); +$result->toXml($writer); +$writer->flush(); + </pre> + </div> +</div> +</span></td> + </tr> + </tbody> + </table> + <h3 id="artifact_ruby_json_client_library">Ruby JSON Client Library</h3> + <p class="lead">Created May 26, 2018</p> + <p><p> + The Ruby JSON client-side library defines the Ruby classes that can be (de)serialized to/from JSON. + This is useful for accessing the REST endpoints that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> + +<p> + This library leverages the <a href="http://json.rubyforge.org/";>Ruby JSON Implementation</a>, which is + required in order to use this library. +</p> + + +<div class="panel panel-default"> + <div class="panel-heading">Ruby JSON Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-ruby"> +require 'net/https' +require 'uri' +//... + +//read a resource from a REST url +url = URI.parse("...") +request = Net::HTTP::Post.new(url.request_uri) +input = Object.new +//set up the Object... +request.body = input.to_json +request['Content-Type'] = "application/json" + +http = Net::HTTP.new(url.host, url.port) +//set up additional http stuff... +res = http.start do |ht| + ht.request(request) +end + +result = Object.from_json(JSON.parse(res.body)) + +//handle the result as needed... + </pre> + </div> +</div> +</p> + <table class="table table-hover downloadfiles"> + <caption>Files</caption> + <thead> + <tr> + <th>name</th> + <th>size</th> + <th>description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="atlas-webapp.rb"> + <td><span class="downloadfile-name">atlas-webapp.rb</span></td> + <td><span class="downloadfile-size">124.83K</span></td> + <td><span class="downloadfile-description"><p> + The Ruby JSON client-side library defines the Ruby classes that can be (de)serialized to/from JSON. + This is useful for accessing the REST endpoints that are published by this application, but only + those that produce a JSON representation of their resources (content type "application/json"). +</p> + +<p> + This library leverages the <a href="http://json.rubyforge.org/";>Ruby JSON Implementation</a>, which is + required in order to use this library. +</p> + + +<div class="panel panel-default"> + <div class="panel-heading">Ruby JSON Example</div> + <div class="panel-body"> + <pre class="prettyprint lang-ruby"> +require 'net/https' +require 'uri' +//... + +//read a resource from a REST url +url = URI.parse("...") +request = Net::HTTP::Post.new(url.request_uri) +input = Object.new +//set up the Object... +request.body = input.to_json +request['Content-Type'] = "application/json" + +http = Net::HTTP.new(url.host, url.port) +//set up additional http stuff... +res = http.start do |ht| + ht.request(request) +end + +result = Object.from_json(JSON.parse(res.body)) + +//handle the result as needed... + </pre> + </div> +</div> +</span></td> + </tr> + </tbody> + </table> + + <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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/index.html ---------------------------------------------------------------------- diff --git a/1.0.0-rc0/api/v2/index.html b/1.0.0-rc0/api/v2/index.html new file mode 100644 index 0000000..1ff0ea6 --- /dev/null +++ b/1.0.0-rc0/api/v2/index.html @@ -0,0 +1,737 @@ +<!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>Apache Atlas Web Application</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">Apache Atlas Web Application</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> + <li><a href="downloads.html">Files and Libraries</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><a href="#resources"><abbr title="Resources"><span class="sideoverflow">Resources</span></abbr></a></li> + <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</span></abbr></a></li> + <li class="divider"></li> + <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="dropdown"><a href="index.html">Home</a></li> + </ol> + + <div class="page-header"> + <h1>Apache Atlas Web Application</h1><p>Apache Atlas Web Application</p> + </div> + + <h1 class="page-header" id="resources">Resources</h1> + + <p> + The resources use a data model that is supported by a set of client-side libraries that are made available on the + <a href="downloads.html">files and libraries</a> page. + </p> + + <p> + There is a <a href="application.wadl">WADL document</a> available that describes the resources API. + </p> + + <p> + You may also enjoy the <a href="ui/index.html">interactive interface</a> provided for this API by <a href="http://swagger.io";>Swagger</a>. + </p> + <p> + <a href="ui/index.html" class="btn btn-default">Try it out!</a> + </p> + + <table class="table table-hover resources"> + <thead> + <tr> + <th align="center">name</th> + <th align="center">path</th> + <th align="center">methods</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="resource_AdminResource.html"> + <td> <span class="resource-name">AdminResource</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/admin/activeSearches</span> +</samp></li><li><samp> <span class="resource-path">/admin/export</span> +</samp></li><li><samp> <span class="resource-path">/admin/import</span> +</samp></li><li><samp> <span class="resource-path">/admin/importfile</span> +</samp></li><li><samp> <span class="resource-path">/admin/metrics</span> +</samp></li><li><samp> <span class="resource-path">/admin/session</span> +</samp></li><li><samp> <span class="resource-path">/admin/stack</span> +</samp></li><li><samp> <span class="resource-path">/admin/status</span> +</samp></li><li><samp> <span class="resource-path">/admin/version</span> +</samp></li><li><samp> <span class="resource-path">/admin/activeSearches/{id}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> +</samp></li></ul></td> + <td> <span class="resource-description">Jersey Resource for admin operations</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_DataSetLineageResource.html"> + <td> <s><span class="resource-name">DataSetLineageResource</span></s> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="resource-path">/lineage/hive/table/{tableName}/schema</span></s> +</samp></li><li><samp> <s><span class="resource-path">/lineage/hive/table/{tableName}/inputs/graph</span></s> +</samp></li><li><samp> <s><span class="resource-path">/lineage/hive/table/{tableName}/outputs/graph</span></s> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li></ul></td> + <td> <s><span class="resource-description">Jersey Resource for Hive Table Lineage.</span></s> +</td> + </tr> + <tr class="clickable-row" data-href="resource_DiscoveryREST.html"> + <td> <span class="resource-name">DiscoveryREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/basic</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/relationship</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/guid/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for data discovery using dsl or full text search</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_EntityREST.html"> + <td> <span class="resource-name">EntityREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/entity</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/classification</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/{guid}/audit</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST for a single entity</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_EntityResource.html"> + <td> <s><span class="resource-name">EntityResource</span></s> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="resource-path">/entities</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/qualifiedName</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}/audit</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}/traitDefinitions</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}/traits</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}/traitDefinitions/{traitName}</span></s> +</samp></li><li><samp> <s><span class="resource-path">/entities/{guid}/traits/{traitName}</span></s> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">POST</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">DELETE</span> </s> +</samp></li></ul></td> + <td> <s><span class="resource-description">Entity management operations as REST API. + +An entity is an "instance" of a Type. Entities conform to the definition +of the Type they correspond with.</span></s> +</td> + </tr> + <tr class="clickable-row" data-href="resource_GlossaryREST.html"> + <td> <span class="resource-name">GlossaryREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/glossary</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/categories</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/detailed</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/related</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/related</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories/headers</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms/headers</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_LineageREST.html"> + <td> <span class="resource-name">LineageREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/lineage/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for an entity's lineage information</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_LineageResource.html"> + <td> <s><span class="resource-name">LineageResource</span></s> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="resource-path">/lineage/{guid}/schema</span></s> +</samp></li><li><samp> <s><span class="resource-path">/lineage/{guid}/inputs/graph</span></s> +</samp></li><li><samp> <s><span class="resource-path">/lineage/{guid}/outputs/graph</span></s> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li></ul></td> + <td> <s><span class="resource-description"></span></s> +</td> + </tr> + <tr class="clickable-row" data-href="resource_MetadataDiscoveryResource.html"> + <td> <s><span class="resource-name">MetadataDiscoveryResource</span></s> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="resource-path">/discovery/search</span></s> +</samp></li><li><samp> <s><span class="resource-path">/discovery/search/dsl</span></s> +</samp></li><li><samp> <s><span class="resource-path">/discovery/search/fulltext</span></s> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li></ul></td> + <td> <s><span class="resource-description">Jersey Resource for metadata operations.</span></s> +</td> + </tr> + <tr class="clickable-row" data-href="resource_RelationshipREST.html"> + <td> <span class="resource-name">RelationshipREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span> +</samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for entity relationships.</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_TypesREST.html"> + <td> <span class="resource-name">TypesREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/types/typedefs</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedefs/headers</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/name/{name}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for CRUD operations on type definitions</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_TypesResource.html"> + <td> <s><span class="resource-name">TypesResource</span></s> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="resource-path">/types</span></s> +</samp></li><li><samp> <s><span class="resource-path">/types/{typeName}</span></s> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <s><span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> </s> +</samp></li><li><samp> <s><span class="label label-default resource-method">GET</span> </s> +</samp></li></ul></td> + <td> <s><span class="resource-description">This class provides RESTful API for Types. + +A type is the description of any representable item; +e.g. a Hive table + +You could represent any meta model representing any domain using these types.</span></s> +</td> + </tr> + </tbody> + </table> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json"><span class="syntax-name">JSON</span></h3> + + <table class="table table-hover datatypes"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedObjectId.html"> + <td> <span class="datatype-name">AtlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">AtlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">AtlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_json"><span class="syntax-name">JSON</span></h3> + + <table class="table table-hover datatypes"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedObjectId.html"> + <td> <span class="datatype-name">AtlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">AtlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">AtlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3> + + <table class="table table-hover datatypes"> + <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="xml_ns0_timeBoundary.html"> + <td> <span class="datatype-name">timeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">atlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">atlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> + <td> <span class="datatype-name">atlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasEntity.html"> + <td> <span class="datatype-name">atlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_status.html"> + <td> <span class="datatype-name">status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasEntityHeader.html"> + <td> <span class="datatype-name">atlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasObjectId.html"> + <td> <span class="datatype-name">atlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasRelatedObjectId.html"> + <td> <span class="datatype-name">atlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasRelationship.html"> + <td> <span class="datatype-name">atlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> + <td> <span class="datatype-name">atlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_propagateTags.html"> + <td> <span class="datatype-name">propagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + </tbody> + </table> + + <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>
