PipelineOptions.VertexDescriptionMode (Flink : 2.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<PipelineOptions.VertexDescriptionMode>
- - org.apache.flink.configuration.PipelineOptions.VertexDescriptionMode

All Implemented Interfaces:

Serializable, Comparable<PipelineOptions.VertexDescriptionMode>

Enclosing class:

PipelineOptions
```
@PublicEvolving
public static enum PipelineOptions.VertexDescriptionMode
extends Enum<PipelineOptions.VertexDescriptionMode>
```
The mode how we organize description of a vertex.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CASCADING`	Organizes the description in a single line cascading mode, which is similar to name.
`TREE`	Organizes the description in a multi line tree mode.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PipelineOptions.VertexDescriptionMode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PipelineOptions.VertexDescriptionMode[]`	`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
  - TREE
```
public static final PipelineOptions.VertexDescriptionMode TREE
```
    Organizes the description in a multi line tree mode.
  - CASCADING
```
public static final PipelineOptions.VertexDescriptionMode CASCADING
```
    Organizes the description in a single line cascading mode, which is similar to name.
- Method Detail
  - values
```
public static PipelineOptions.VertexDescriptionMode[] 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 (PipelineOptions.VertexDescriptionMode c : PipelineOptions.VertexDescriptionMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PipelineOptions.VertexDescriptionMode 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