Segments (druid-server 29.0.1 API)

java.lang.Object
- java.lang.Enum<Segments>
- - org.apache.druid.indexing.overlord.Segments

All Implemented Interfaces:

Serializable, Comparable<Segments>
```
public enum Segments
extends Enum<Segments>
```
This enum is used as a parameter for several methods in IndexerMetadataStorageCoordinator, specifying whether only visible segments, or visible as well as overshadowed segments should be included in results. Visibility (and overshadowness - these terms are antonyms) may be defined on an interval (or a series of intervals). Consider the following example: |----| I |----| S' |-------| S Here, I denotes an interval in question, S and S' are segments. S' is newer (has a higher version) than S. Segment S is overshadowed (by S') on the interval I, though it's visible (non-overshadowed) outside of I: more specifically, it's visible on the interval [end of S', end of S]. A segment is considered visible on a series of intervals if it's visible on any of the intervals in the series. A segment is considered (fully) overshadowed on a series of intervals if it's overshadowed (= non-visible) on all of the intervals in the series. If not specified otherwise, visibility (or overshadowness) should be assumed on the interval (-inf, +inf).

Enum Constant Summary

Enum Constants
Enum Constant	Description
`INCLUDING_OVERSHADOWED`	Specifies that visible as well as overshadowed segments should be included in results.
`ONLY_VISIBLE`	Specifies that only visible segments should be included in results.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Segments`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Segments[]`	`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
  - ONLY_VISIBLE
```
public static final Segments ONLY_VISIBLE
```
    Specifies that only visible segments should be included in results.
  - INCLUDING_OVERSHADOWED
```
public static final Segments INCLUDING_OVERSHADOWED
```
    Specifies that visible as well as overshadowed segments should be included in results.
- Method Detail
  - values
```
public static Segments[] 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 (Segments c : Segments.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Segments 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