openlineage javadoc update

static/apidocs/javadoc/deprecated-list.html

@@ -97,6 +97,7 @@ <h1 title="Deprecated API" class="title">Deprecated API</h1>
 <h2 title="Contents">Contents</h2>
 <ul>
 <li><a href="#class">Classes</a></li>
+<li><a href="#method">Methods</a></li>
 </ul>
 </div>
 <div class="contentContainer"><a id="class">
@@ -121,6 +122,26 @@ <h2 title="Contents">Contents</h2>
 </table>
 </li>
 </ul>
+<a id="method">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<table class="deprecatedSummary">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Method</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<th class="colDeprecatedItemName" scope="row"><a href="io/openlineage/client/transports/FacetsConfig.html#getDeprecatedDisabledFacets()">io.openlineage.client.transports.FacetsConfig.getDeprecatedDisabledFacets()</a></th>
+<td class="colLast"></td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
 </div>
 </main>
 <footer role="contentinfo">

static/apidocs/javadoc/index-all.html

@@ -827,7 +827,7 @@ <h2 class="title">F</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#%3Cinit%3E()">FacetsConfig()</a></span> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#%3Cinit%3E(java.lang.String%5B%5D,java.lang.String%5B%5D)">FacetsConfig(String[], String[])</a></span> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#%3Cinit%3E(java.lang.String%5B%5D,java.lang.String%5B%5D,java.util.Map)">FacetsConfig(String[], String[], Map&lt;String, Boolean&gt;)</a></span> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineage.RunEvent.EventType.html#FAIL">FAIL</a></span> - io.openlineage.client.<a href="io/openlineage/client/OpenLineage.RunEvent.EventType.html" title="enum in io.openlineage.client">OpenLineage.RunEvent.EventType</a></dt>
 <dd>&nbsp;</dd>
@@ -1361,6 +1361,10 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineage.DatasetFacets.html#getDataSource()">getDataSource()</a></span> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.DatasetFacets.html" title="class in io.openlineage.client">OpenLineage.DatasetFacets</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#getDeprecatedDisabledFacets()">getDeprecatedDisabledFacets()</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dd>
+<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
+</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations.html#getDescription()">getDescription()</a></span> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations.html" title="class in io.openlineage.client">OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineage.DocumentationDatasetFacet.html#getDescription()">getDescription()</a></span> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.DocumentationDatasetFacet.html" title="class in io.openlineage.client">OpenLineage.DocumentationDatasetFacet</a></dt>
@@ -1379,6 +1383,10 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineage.JobFacets.html#getDocumentation()">getDocumentation()</a></span> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.JobFacets.html" title="class in io.openlineage.client">OpenLineage.JobFacets</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#getEffectiveDisabledFacets()">getEffectiveDisabledFacets()</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dd>
+<div class="block">Merges deprecated and new mechanism for disabled facets into one effective list</div>
+</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/transports/HttpConfig.html#getEndpoint()">getEndpoint()</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/HttpConfig.html" title="class in io.openlineage.client.transports">HttpConfig</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/transports/HttpTransport.Builder.html#getEndpoint()">getEndpoint()</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/HttpTransport.Builder.html" title="class in io.openlineage.client.transports">HttpTransport.Builder</a></dt>
@@ -2883,6 +2891,10 @@ <h2 class="title">O</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/utils/filesystem/ObjectStorageDatasetExtractor.html#%3Cinit%3E(java.lang.String)">ObjectStorageDatasetExtractor(String)</a></span> - Constructor for class io.openlineage.client.utils.filesystem.<a href="io/openlineage/client/utils/filesystem/ObjectStorageDatasetExtractor.html" title="class in io.openlineage.client.utils.filesystem">ObjectStorageDatasetExtractor</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#onOtherProperty(java.lang.String,java.lang.Object)">onOtherProperty(String, Object)</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dd>
+<div class="block">This method accepts every other property we may receive in configuration.</div>
+</dd>
 <dt><a href="io/openlineage/client/OpenLineage.html" title="class in io.openlineage.client"><span class="typeNameLink">OpenLineage</span></a> - Class in <a href="io/openlineage/client/package-summary.html">io.openlineage.client</a></dt>
 <dd>
 <div class="block">Usage:</div>
@@ -3939,7 +3951,9 @@ <h2 class="title">S</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/OpenLineageConfig.html#setDatasetConfig(io.openlineage.client.dataset.DatasetConfig)">setDatasetConfig(DatasetConfig)</a></span> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineageConfig.html" title="class in io.openlineage.client">OpenLineageConfig</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#setDisabledFacets(java.lang.String%5B%5D)">setDisabledFacets(String[])</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#setDeprecatedDisabledFacets(java.lang.String%5B%5D)">setDeprecatedDisabledFacets(String[])</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="io/openlineage/client/transports/FacetsConfig.html#setDisabledFacets(java.util.Map)">setDisabledFacets(Map&lt;String, Boolean&gt;)</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="io/openlineage/client/transports/HttpConfig.html#setEndpoint(java.lang.String)">setEndpoint(String)</a></span> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/HttpConfig.html" title="class in io.openlineage.client.transports">HttpConfig</a></dt>
 <dd>&nbsp;</dd>

static/apidocs/javadoc/io/openlineage/client/transports/FacetsConfig.html

@@ -27,8 +27,8 @@
     catch(err) {
     }
 //-->
-var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
@@ -162,8 +162,9 @@ <h3>Constructor Summary</h3>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String%5B%5D,java.lang.String%5B%5D)">FacetsConfig</a></span>&#8203;(java.lang.String[]&nbsp;disabledFacets,
-            java.lang.String[]&nbsp;customEnvironmentVariables)</code></th>
+<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String%5B%5D,java.lang.String%5B%5D,java.util.Map)">FacetsConfig</a></span>&#8203;(java.lang.String[]&nbsp;deprecatedDisabledFacets,
+            java.lang.String[]&nbsp;customEnvironmentVariables,
+            java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;&nbsp;disabledFacets)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
@@ -178,7 +179,7 @@ <h3>Constructor Summary</h3>
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
@@ -191,22 +192,49 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeprecatedDisabledFacets()">getDeprecatedDisabledFacets</a></span>()</code></th>
+<td class="colLast">
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDisabledFacets()">getDisabledFacets</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i2" class="altColor">
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>java.lang.String[]</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectiveDisabledFacets()">getEffectiveDisabledFacets</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Merges deprecated and new mechanism for disabled facets into one effective list</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mergeWithNonNull(io.openlineage.client.transports.FacetsConfig)">mergeWithNonNull</a></span>&#8203;(<a href="FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a>&nbsp;facetsConfig)</code></th>
 <td class="colLast">
 <div class="block">Method to create new config class based on current instance and non-null argument value.</div>
 </td>
 </tr>
-<tr id="i3" class="rowColor">
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onOtherProperty(java.lang.String,java.lang.Object)">onOtherProperty</a></span>&#8203;(java.lang.String&nbsp;key,
+               java.lang.Object&nbsp;value)</code></th>
+<td class="colLast">
+<div class="block">This method accepts every other property we may receive in configuration.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDisabledFacets(java.lang.String%5B%5D)">setDisabledFacets</a></span>&#8203;(java.lang.String[]&nbsp;disabledFacets)</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeprecatedDisabledFacets(java.lang.String%5B%5D)">setDeprecatedDisabledFacets</a></span>&#8203;(java.lang.String[]&nbsp;disabledFacets)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i4" class="altColor">
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDisabledFacets(java.util.Map)">setDisabledFacets</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;&nbsp;disabledFacets)</code></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr id="i8" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
@@ -251,14 +279,15 @@ <h4>FacetsConfig</h4>
 <pre>public&nbsp;FacetsConfig()</pre>
 </li>
 </ul>
-<a id="&lt;init&gt;(java.lang.String[],java.lang.String[])">
+<a id="&lt;init&gt;(java.lang.String[],java.lang.String[],java.util.Map)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>FacetsConfig</h4>
-<pre>public&nbsp;FacetsConfig&#8203;(java.lang.String[]&nbsp;disabledFacets,
-                    java.lang.String[]&nbsp;customEnvironmentVariables)</pre>
+<pre>public&nbsp;FacetsConfig&#8203;(java.lang.String[]&nbsp;deprecatedDisabledFacets,
+                    java.lang.String[]&nbsp;customEnvironmentVariables,
+                    java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;&nbsp;disabledFacets)</pre>
 </li>
 </ul>
 </li>
@@ -271,6 +300,32 @@ <h4>FacetsConfig</h4>
 <!--   -->
 </a>
 <h3>Method Detail</h3>
+<a id="setDeprecatedDisabledFacets(java.lang.String[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDeprecatedDisabledFacets</h4>
+<pre class="methodSignature">public&nbsp;void&nbsp;setDeprecatedDisabledFacets&#8203;(java.lang.String[]&nbsp;disabledFacets)</pre>
+</li>
+</ul>
+<a id="onOtherProperty(java.lang.String,java.lang.Object)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>onOtherProperty</h4>
+<pre class="methodSignature">public&nbsp;void&nbsp;onOtherProperty&#8203;(java.lang.String&nbsp;key,
+                            java.lang.Object&nbsp;value)</pre>
+<div class="block">This method accepts every other property we may receive in configuration. The only supported
+ properties now are the "disabled" facet properties. The rest is silently ignored.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>key</code> - the name of the property which is not directly deserialized to any other field</dd>
+<dd><code>value</code> - the value of the property. Can be a map for nested fields</dd>
+</dl>
+</li>
+</ul>
 <a id="mergeWithNonNull(io.openlineage.client.transports.FacetsConfig)">
 <!--   -->
 </a>
@@ -292,6 +347,20 @@ <h4>mergeWithNonNull</h4>
 </dl>
 </li>
 </ul>
+<a id="getEffectiveDisabledFacets()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEffectiveDisabledFacets</h4>
+<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getEffectiveDisabledFacets()</pre>
+<div class="block">Merges deprecated and new mechanism for disabled facets into one effective list</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array of disabled facets including facets from new and deprecated mechanisms.</dd>
+</dl>
+</li>
+</ul>
 <a id="toString()">
 <!--   -->
 </a>
@@ -305,31 +374,42 @@ <h4>toString</h4>
 </dl>
 </li>
 </ul>
-<a id="getDisabledFacets()">
+<a id="getDeprecatedDisabledFacets()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
-<h4>getDisabledFacets</h4>
-<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getDisabledFacets()</pre>
+<h4>getDeprecatedDisabledFacets</h4>
+<pre class="methodSignature">@Deprecated
+public&nbsp;java.lang.String[]&nbsp;getDeprecatedDisabledFacets()</pre>
+<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 </li>
 </ul>
-<a id="setDisabledFacets(java.lang.String[])">
+<a id="getCustomEnvironmentVariables()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
-<h4>setDisabledFacets</h4>
-<pre class="methodSignature">public&nbsp;void&nbsp;setDisabledFacets&#8203;(java.lang.String[]&nbsp;disabledFacets)</pre>
+<h4>getCustomEnvironmentVariables</h4>
+<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getCustomEnvironmentVariables()</pre>
 </li>
 </ul>
-<a id="getCustomEnvironmentVariables()">
+<a id="getDisabledFacets()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDisabledFacets</h4>
+<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;&nbsp;getDisabledFacets()</pre>
+</li>
+</ul>
+<a id="setDisabledFacets(java.util.Map)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
-<h4>getCustomEnvironmentVariables</h4>
-<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getCustomEnvironmentVariables()</pre>
+<h4>setDisabledFacets</h4>
+<pre class="methodSignature">public&nbsp;void&nbsp;setDisabledFacets&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Boolean&gt;&nbsp;disabledFacets)</pre>
 </li>
 </ul>
 </li>