org.apache.flink.annotation.docs

Annotation Type Documentation.CommonOption

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Internal
public static @interface Documentation.CommonOption

Annotation used on config option fields to include them in the "Common Options" section.

The position() argument controls the position in the generated table, with lower values being placed at the top. Fields with the same position are sorted alphabetically by key.

Field Summary

Fields

Modifier and Type	Fields and Description
static int	POSITION_FAULT_TOLERANCE
static int	POSITION_HIGH_AVAILABILITY
static int	POSITION_MEMORY
static int	POSITION_PARALLELISM_SLOTS
static int	POSITION_SECURITY

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	position

Field Detail

POSITION_MEMORY

public static final int POSITION_MEMORY

POSITION_PARALLELISM_SLOTS

public static final int POSITION_PARALLELISM_SLOTS

POSITION_FAULT_TOLERANCE

public static final int POSITION_FAULT_TOLERANCE

POSITION_HIGH_AVAILABILITY

public static final int POSITION_HIGH_AVAILABILITY

POSITION_SECURITY

public static final int POSITION_SECURITY

Element Detail

position

public abstract int position

Default:

2147483647