DataflowWorkerLoggingOptions.Level (Apache Beam SDK for Java 0.1.0-incubating API)

java.lang.Object
-
- java.lang.Enum<DataflowWorkerLoggingOptions.Level>
- -
  - org.apache.beam.runners.dataflow.options.DataflowWorkerLoggingOptions.Level
  -
-

-
-
All Implemented Interfaces:
-
Serializable, Comparable<DataflowWorkerLoggingOptions.Level>
-
-
-
Enclosing interface:
-
DataflowWorkerLoggingOptions
-
-
-
-
```
public static enum DataflowWorkerLoggingOptions.Level
-extends Enum<DataflowWorkerLoggingOptions.Level>
```
-
The set of log levels that can be used on the Dataflow worker.
-

- -

- - -
Enum Constant Summary
- - - - - - - - - - - - - - - - - - - - -
Enum Constants
Enum Constant and Description
DEBUG
ERROR
INFO
TRACE
WARN
-

Enum Constants
Enum Constant and Description
`DEBUG`
`ERROR`
`INFO`
`TRACE`
`WARN`

- -

Method Summary

- - - - - - - - - - - - - - -

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DataflowWorkerLoggingOptions.Level`	`valueOf(String name)` - Returns the enum constant of this type with the specified name. -
`static DataflowWorkerLoggingOptions.Level[]`	`values()` - Returns an array containing the constants of this enum type, in -the order they are declared. -

- - -
Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

- - -
Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait

- -
- - - -
  Enum Constant Detail
  - - - -
  - -
    DEBUG
    -
```
public static final DataflowWorkerLoggingOptions.Level DEBUG
```
    -
  - - - -
  - -
    ERROR
    -
```
public static final DataflowWorkerLoggingOptions.Level ERROR
```
    -
  - - - -
  - -
    INFO
    -
```
public static final DataflowWorkerLoggingOptions.Level INFO
```
    -
  - - - -
  - -
    TRACE
    -
```
public static final DataflowWorkerLoggingOptions.Level TRACE
```
    -
  - - - -
  - -
    WARN
    -
```
public static final DataflowWorkerLoggingOptions.Level WARN
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    values
    -
```
public static DataflowWorkerLoggingOptions.Level[] values()
```
    -
    Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
```
-for (DataflowWorkerLoggingOptions.Level c : DataflowWorkerLoggingOptions.Level.values())
-    System.out.println(c);
-
```
    -
    -
    Returns:
    -
    an array containing the constants of this enum type, in the order they are declared
    -
    -
  - - - -
  - -
    valueOf
    -
```
public static DataflowWorkerLoggingOptions.Level valueOf(String name)
```
    -
    Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
    -
    -
    Parameters:
    -
    name - the name of the enum constant to be returned.
    -
    Returns:
    -
    the enum constant with the specified name
    -
    Throws:
    -
    IllegalArgumentException - if this enum type has no constant with the specified name
    -
    NullPointerException - if the argument is null
    -
    -
  -
-

java.lang.Object
-
- java.util.AbstractMap<K,V>
- -
  - java.util.HashMap<String,DataflowWorkerLoggingOptions.Level>
  - -
    - org.apache.beam.runners.dataflow.options.DataflowWorkerLoggingOptions.WorkerLogLevelOverrides
    -
  -
-

-
-
All Implemented Interfaces:
-
Serializable, Cloneable, Map<String,DataflowWorkerLoggingOptions.Level>
-
-
-
Enclosing interface:
-
DataflowWorkerLoggingOptions
-
-
-
-
```
public static class DataflowWorkerLoggingOptions.WorkerLogLevelOverrides
-extends HashMap<String,DataflowWorkerLoggingOptions.Level>
```
-
Defines a log level override for a specific class, package, or name. - -
java.util.logging is used on the Dataflow worker harness and 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 a.b.c.Foo, a.b.c.Xyz, and a.b.Bar, with - loggers named "a.b.c.Foo", "a.b.c.Xyz", and "a.b.Bar" respectively, - we can override the log levels: -
- for Foo by specifying the name "a.b.c.Foo" or the Class - representing a.b.c.Foo. -
- for Foo, Xyz, and Bar by specifying the name "a.b" or - the Package representing a.b. -
- for Foo and Bar by specifying both of their names or classes. -
- Note that by specifying multiple overrides, the exact name followed by the closest parent - takes precedence.
-
-
See Also:
-
Serialized Form
-
-

- -

- - -
Nested Class Summary
-
- - - -
  Nested classes/interfaces inherited from class java.util.AbstractMap
  -AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
- - - -
  Nested classes/interfaces inherited from interface java.util.Map
  -Map.Entry<K,V>
-

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
WorkerLogLevelOverrides()
-

Constructors
Constructor and Description
`WorkerLogLevelOverrides()`

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - -

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataflowWorkerLoggingOptions.WorkerLogLevelOverrides`	`addOverrideForClass(Class<?> klass, - DataflowWorkerLoggingOptions.Level level)` - Overrides the default log level for the passed in class. -
`DataflowWorkerLoggingOptions.WorkerLogLevelOverrides`	`addOverrideForName(String name, - DataflowWorkerLoggingOptions.Level level)` - Overrides the default log level for the passed in name. -
`DataflowWorkerLoggingOptions.WorkerLogLevelOverrides`	`addOverrideForPackage(Package pkg, - DataflowWorkerLoggingOptions.Level level)` - Overrides the default log level for the passed in package. -
`static DataflowWorkerLoggingOptions.WorkerLogLevelOverrides`	`from(Map<String,String> values)` - Expects a map keyed by logger `Name`s with values representing `Level`s. -

- - -
Methods inherited from class java.util.HashMap
-clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- - -
Methods inherited from class java.util.AbstractMap
-equals, hashCode, toString

- - -
Methods inherited from class java.lang.Object
-finalize, getClass, notify, notifyAll, wait, wait, wait

- - -
Methods inherited from interface java.util.Map
-equals, hashCode

- -
- - - -
  Constructor Detail
  - - - -
  - -
    WorkerLogLevelOverrides
    -
```
public WorkerLogLevelOverrides()
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    addOverrideForClass
    -
```
public DataflowWorkerLoggingOptions.WorkerLogLevelOverrides addOverrideForClass(Class<?> klass,
-                                                                                DataflowWorkerLoggingOptions.Level level)
```
    -
    Overrides the default log level for the passed in class. - -
    This is equivalent to calling - addOverrideForName(String, DataflowWorkerLoggingOptions.Level) - and passing in the class name.
    -
  - - - -
  - -
    addOverrideForPackage
    -
```
public DataflowWorkerLoggingOptions.WorkerLogLevelOverrides addOverrideForPackage(Package pkg,
-                                                                                  DataflowWorkerLoggingOptions.Level level)
```
    -
    Overrides the default log level for the passed in package. - -
    This is equivalent to calling - addOverrideForName(String, DataflowWorkerLoggingOptions.Level) - and passing in the package name.
    -
  - - - -
  - -
    addOverrideForName
    -
```
public DataflowWorkerLoggingOptions.WorkerLogLevelOverrides addOverrideForName(String name,
-                                                                               DataflowWorkerLoggingOptions.Level level)
```
    -
    Overrides the default log level for the passed in name. - -
    Note that because of the hierarchical nature of logger names, this will - override the log level of all loggers that have the passed in name or - a parent logger that has the passed in name.
    -
  - - - -
  - -
    from
    -
```
public static DataflowWorkerLoggingOptions.WorkerLogLevelOverrides from(Map<String,String> values)
```
    -
    Expects a map keyed by logger Names with values representing Levels. - The Name generally represents the fully qualified Java - class name, or fully qualified Java - package name, or custom logger name. The Level - represents the log level and must be one of DataflowWorkerLoggingOptions.Level.
    -
  -
-

-
-
All Superinterfaces:
-
HasDisplayData, PipelineOptions
-
-
-
All Known Subinterfaces:
-
BlockingDataflowPipelineOptions, DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions
-
-
-
-
```
public interface DataflowWorkerLoggingOptions
-extends PipelineOptions
```
-
Options that are used to control logging configuration on the Dataflow worker.
-

- -

- - -

Nested Class Summary

- - - - - - - - - - - - - - -

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DataflowWorkerLoggingOptions.Level` - The set of log levels that can be used on the Dataflow worker. -
`static class`	`DataflowWorkerLoggingOptions.WorkerLogLevelOverrides` - Defines a log level override for a specific class, package, or name. -

- - -
Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions
-PipelineOptions.CheckEnabled

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DataflowWorkerLoggingOptions.Level`	`getDefaultWorkerLogLevel()` - This option controls the default log level of all loggers without a log level override. -
`DataflowWorkerLoggingOptions.WorkerLogLevelOverrides`	`getWorkerLogLevelOverrides()` - This option controls the log levels for specifically named loggers. -
`void`	`setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)`
`void`	`setWorkerLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)`

- - -
Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions
-as, cloneAs, getRunner, getStableUniqueNames, getTempLocation, setRunner, setStableUniqueNames, setTempLocati on

- - -
Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData
-populateDisplayData

- -
- - - -
  Method Detail
  - - - -
  - -
    getDefaultWorkerLogLevel
    -
```
@Default.Enum(value="INFO")
-DataflowWorkerLoggingOptions.Level getDefaultWorkerLogLevel()
```
    -
    This option controls the default log level of all loggers without a log level override.
    -
  - - - -
  - -
    setDefaultWorkerLogLevel
    -
```
void setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)
```
    -
  - - - -
  - -
    getWorkerLogLevelOverrides
    -
```
DataflowWorkerLoggingOptions.WorkerLogLevelOverrides getWorkerLogLevelOverrides()
```
    -
    This option controls the log levels for specifically named loggers. - -
    Later options with equivalent names override earlier options. - -
    See DataflowWorkerLoggingOptions.WorkerLogLevelOverrides for more information on how to configure logging - on a per Class, Package, or name basis. If used from the command line, - the expected format is {"Name":"Level",...}, further details on - DataflowWorkerLoggingOptions.WorkerLogLevelOverrides.from(java.util.Map<java.lang.String, java.lang.String>).
    -
  - - - -
  - -
    setWorkerLogLevelOverrides
    -
```
void setWorkerLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)
```
    -
  -
-

Enum DataflowWorkerLoggingOptions.Level

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DEBUG

ERROR

INFO

TRACE

WARN

Method Detail

values

valueOf

Class DataflowWorkerLoggingOptions.WorkerLogLevelOverrides

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

WorkerLogLevelOverrides

Method Detail

addOverrideForClass

addOverrideForPackage

addOverrideForName

from

Interface DataflowWorkerLoggingOptions

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

Method Summary

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

Method Detail

getDefaultWorkerLogLevel

setDefaultWorkerLogLevel

getWorkerLogLevelOverrides

setWorkerLogLevelOverrides

Uses of Classorg.apache.beam.runners.dataflow.options.BlockingDataflowPipelineOptions.StandardOutputFactory

Uses of Class
org.apache.beam.runners.dataflow.options.BlockingDataflowPipelineOptions.StandardOutputFactory