blob: 54addb08196c9a14efe7ce4ff42ed99e7e772006 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 -->
<title>SdkHarnessOptions.SdkHarnessLogLevelOverrides (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SdkHarnessOptions.SdkHarnessLogLevelOverrides (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" target="_top">Frames</a></li>
<li><a href="SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.options</div>
<h2 title="Class SdkHarnessOptions.SdkHarnessLogLevelOverrides" class="title">Class SdkHarnessOptions.SdkHarnessLogLevelOverrides</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractMap&lt;K,V&gt;</li>
<li>
<ul class="inheritance">
<li>java.util.HashMap&lt;java.lang.String,<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.options.SdkHarnessOptions.SdkHarnessLogLevelOverrides</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable, java.util.Map&lt;java.lang.String,<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.html" title="interface in org.apache.beam.sdk.options">SdkHarnessOptions</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">SdkHarnessOptions.SdkHarnessLogLevelOverrides</span>
extends java.util.HashMap&lt;java.lang.String,<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&gt;</pre>
<div class="block">Defines a log level override for a specific class, package, or name.
<p>The SDK harness supports a logging hierarchy based off of names that are "." separated. It
is a common pattern to have the logger for a given class share the same name as the class
itself. Given the classes <code>a.b.c.Foo</code>, <code>a.b.c.Xyz</code>, and <code>a.b.Bar</code>, with
loggers named <code>"a.b.c.Foo"</code>, <code>"a.b.c.Xyz"</code>, and <code>"a.b.Bar"</code> respectively, we
can override the log levels:
<ul>
<li>for <code>Foo</code> by specifying the name <code>"a.b.c.Foo"</code> or the <code>Class</code>
representing <code>a.b.c.Foo</code>.
<li>for <code>Foo</code>, <code>Xyz</code>, and <code>Bar</code> by specifying the name <code>"a.b"</code> or the
<code>Package</code> representing <code>a.b</code>.
<li>for <code>Foo</code> and <code>Bar</code> by specifying both of their names or classes.
</ul>
<p><code>System.out</code> and <code>System.err</code> messages are configured via loggers of the
corresponding name. Note that by specifying multiple overrides, the exact name followed by the
closest parent takes precedence.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.options.SdkHarnessOptions.SdkHarnessLogLevelOverrides">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.AbstractMap">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;java.util.AbstractMap</h3>
<code>java.util.AbstractMap.SimpleEntry&lt;K,V&gt;, java.util.AbstractMap.SimpleImmutableEntry&lt;K,V&gt;</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;java.util.Map</h3>
<code>java.util.Map.Entry&lt;K,V&gt;</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html#SdkHarnessLogLevelOverrides--">SdkHarnessLogLevelOverrides</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html#addOverrideForClass-java.lang.Class-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">addOverrideForClass</a></span>(java.lang.Class&lt;?&gt;&nbsp;klass,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</code>
<div class="block">Overrides the default log level for the passed in class.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html#addOverrideForName-java.lang.String-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">addOverrideForName</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</code>
<div class="block">Overrides the default log logLevel for the passed in name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html#addOverrideForPackage-java.lang.Package-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">addOverrideForPackage</a></span>(java.lang.Package&nbsp;pkg,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</code>
<div class="block">Overrides the default log level for the passed in package.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html#from-java.util.Map-">from</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;values)</code>
<div class="block">Expects a map keyed by logger <code>Name</code>s with values representing <code>LogLevel</code>s.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.HashMap">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.util.HashMap</h3>
<code>clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractMap">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.util.AbstractMap</h3>
<code>equals, hashCode, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Map">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Map</h3>
<code>equals, hashCode</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SdkHarnessLogLevelOverrides--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SdkHarnessLogLevelOverrides</h4>
<pre>public&nbsp;SdkHarnessLogLevelOverrides()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addOverrideForClass-java.lang.Class-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOverrideForClass</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a>&nbsp;addOverrideForClass(java.lang.Class&lt;?&gt;&nbsp;klass,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</pre>
<div class="block">Overrides the default log level for the passed in class.
<p>This is equivalent to calling <code>#addOverrideForName(String, LogLevel)</code> and passing in
the <code>class name</code>.</div>
</li>
</ul>
<a name="addOverrideForPackage-java.lang.Package-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOverrideForPackage</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a>&nbsp;addOverrideForPackage(java.lang.Package&nbsp;pkg,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</pre>
<div class="block">Overrides the default log level for the passed in package.
<p>This is equivalent to calling <code>#addOverrideForName(String, LogLevel)</code> and passing in
the <code>package name</code>.</div>
</li>
</ul>
<a name="addOverrideForName-java.lang.String-org.apache.beam.sdk.options.SdkHarnessOptions.LogLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOverrideForName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a>&nbsp;addOverrideForName(java.lang.String&nbsp;name,
<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a>&nbsp;logLevel)</pre>
<div class="block">Overrides the default log logLevel for the passed in name.
<p>Note that because of the hierarchical nature of logger names, this will override the log
logLevel of all loggers that have the passed in name or a parent logger that has the passed
in name.</div>
</li>
</ul>
<a name="from-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>from</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a>&nbsp;from(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;values)</pre>
<div class="block">Expects a map keyed by logger <code>Name</code>s with values representing <code>LogLevel</code>s. The
<code>Name</code> generally represents the fully qualified Java <code>class
name</code>, or fully qualified Java <code>package name</code>, or custom logger name.
The <code>LogLevel</code> represents the log level and must be one of <a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options"><code>SdkHarnessOptions.LogLevel</code></a>.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" target="_top">Frames</a></li>
<li><a href="SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>