org.graylog2.indexer.indexset

Class IndexSetConfig

java.lang.Object

org.graylog2.indexer.indexset.IndexSetConfig

All Implemented Interfaces:

Comparable<IndexSetConfig>

public abstract class IndexSetConfig
extends Object
implements Comparable<IndexSetConfig>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexSetConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INDEX_TEMPLATE_TYPE
static String	FIELD_CREATION_DATE
static String	FIELD_INDEX_PREFIX
static String	FIELD_INDEX_TEMPLATE_TYPE
static String	FIELD_REGULAR
static String	INDEX_PREFIX_REGEX

Constructor Summary

Constructors

Constructor and Description
IndexSetConfig()

Method Summary

Modifier and Type	Method and Description
static IndexSetConfig.Builder	builder()
int	compareTo(IndexSetConfig o)
static IndexSetConfig	create(String title, String description, boolean isWritable, Boolean isRegular, String indexPrefix, int shards, int replicas, String rotationStrategyClass, RotationStrategyConfig rotationStrategy, String retentionStrategyClass, RetentionStrategyConfig retentionStrategy, ZonedDateTime creationDate, String indexAnalyzer, String indexTemplateName, String indexTemplateType, int indexOptimizationMaxNumSegments, boolean indexOptimizationDisabled)
static IndexSetConfig	create(String id, String title, String description, boolean isWritable, Boolean isRegular, String indexPrefix, int shards, int replicas, String rotationStrategyClass, RotationStrategyConfig rotationStrategy, String retentionStrategyClass, RetentionStrategyConfig retentionStrategy, ZonedDateTime creationDate, String indexAnalyzer, String indexTemplateName, String indexTemplateType, int indexOptimizationMaxNumSegments, boolean indexOptimizationDisabled)
static IndexSetConfig	create(String id, @NotBlank String title, String description, Boolean isWritable, Boolean isRegular, @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String indexPrefix, String indexMatchPattern, String indexWildcard, @Min(value=1L) int shards, @Min(value=0L) int replicas, String rotationStrategyClass, @NotNull RotationStrategyConfig rotationStrategy, String retentionStrategyClass, @NotNull RetentionStrategyConfig retentionStrategy, @NotNull ZonedDateTime creationDate, String indexAnalyzer, String indexTemplateName, String indexTemplateType, Integer maxNumSegments, Boolean indexOptimizationDisabled, org.joda.time.Duration fieldTypeRefreshInterval)
abstract @NotNull ZonedDateTime	creationDate()
abstract String	description()
abstract org.joda.time.Duration	fieldTypeRefreshInterval()
abstract String	id()
abstract @NotBlank String	indexAnalyzer()
abstract String	indexMatchPattern()
abstract boolean	indexOptimizationDisabled()
abstract @Min(value=1L) int	indexOptimizationMaxNumSegments()
abstract @NotBlank @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String	indexPrefix()
abstract @NotBlank String	indexTemplateName()
abstract @NotBlank Optional<String>	indexTemplateType()
abstract String	indexWildcard()
abstract Optional<Boolean>	isRegular() Indicates whether this index set is intended to store messages ingested by user, not by the system
boolean	isRegularIndex()
abstract boolean	isWritable()
abstract @Min(value=0L) int	replicas()
abstract @NotNull RetentionStrategyConfig	retentionStrategy()
abstract String	retentionStrategyClass()
abstract @NotNull RotationStrategyConfig	rotationStrategy()
abstract String	rotationStrategyClass()
abstract @Min(value=1L) int	shards()
abstract @NotBlank String	title()
abstract IndexSetConfig.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_INDEX_PREFIX

public static final String FIELD_INDEX_PREFIX

See Also:

Constant Field Values

FIELD_CREATION_DATE

public static final String FIELD_CREATION_DATE

See Also:

Constant Field Values

FIELD_INDEX_TEMPLATE_TYPE

public static final String FIELD_INDEX_TEMPLATE_TYPE

See Also:

Constant Field Values

FIELD_REGULAR

public static final String FIELD_REGULAR

See Also:

Constant Field Values

INDEX_PREFIX_REGEX

public static final String INDEX_PREFIX_REGEX

See Also:

Constant Field Values

DEFAULT_INDEX_TEMPLATE_TYPE

public static final String DEFAULT_INDEX_TEMPLATE_TYPE

See Also:

Constant Field Values

Constructor Detail

IndexSetConfig

public IndexSetConfig()

Method Detail

id

@Nullable
public abstract String id()

title

@NotBlank
public abstract @NotBlank String title()

description

@Nullable
public abstract String description()

isWritable

public abstract boolean isWritable()

isRegular

public abstract Optional<Boolean> isRegular()

Indicates whether this index set is intended to store messages ingested by user, not by the system

indexPrefix

@NotBlank
 @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$")
public abstract @NotBlank @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String indexPrefix()

indexMatchPattern

@Nullable
public abstract String indexMatchPattern()

indexWildcard

@Nullable
public abstract String indexWildcard()

shards

@Min(value=1L)
public abstract @Min(value=1L) int shards()

replicas

@Min(value=0L)
public abstract @Min(value=0L) int replicas()

rotationStrategyClass

@Nullable
public abstract String rotationStrategyClass()

rotationStrategy

@NotNull
public abstract @NotNull RotationStrategyConfig rotationStrategy()

retentionStrategyClass

@Nullable
public abstract String retentionStrategyClass()

retentionStrategy

@NotNull
public abstract @NotNull RetentionStrategyConfig retentionStrategy()

creationDate

@NotNull
public abstract @NotNull ZonedDateTime creationDate()

indexAnalyzer

@NotBlank
public abstract @NotBlank String indexAnalyzer()

indexTemplateName

@NotBlank
public abstract @NotBlank String indexTemplateName()

indexTemplateType

@NotBlank
public abstract @NotBlank Optional<String> indexTemplateType()

indexOptimizationMaxNumSegments

@Min(value=1L)
public abstract @Min(value=1L) int indexOptimizationMaxNumSegments()

indexOptimizationDisabled

public abstract boolean indexOptimizationDisabled()

fieldTypeRefreshInterval

public abstract org.joda.time.Duration fieldTypeRefreshInterval()

isRegularIndex

public boolean isRegularIndex()

create

public static IndexSetConfig create(@Nullable
                                    String id,
                                    @NotBlank
                                    @NotBlank String title,
                                    @Nullable
                                    String description,
                                    @Nullable
                                    Boolean isWritable,
                                    @Nullable
                                    Boolean isRegular,
                                    @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$")
                                    @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String indexPrefix,
                                    @Nullable
                                    String indexMatchPattern,
                                    @Nullable
                                    String indexWildcard,
                                    @Min(value=1L)
                                    @Min(value=1L) int shards,
                                    @Min(value=0L)
                                    @Min(value=0L) int replicas,
                                    @Nullable
                                    String rotationStrategyClass,
                                    @NotNull
                                    @NotNull RotationStrategyConfig rotationStrategy,
                                    @Nullable
                                    String retentionStrategyClass,
                                    @NotNull
                                    @NotNull RetentionStrategyConfig retentionStrategy,
                                    @NotNull
                                    @NotNull ZonedDateTime creationDate,
                                    @Nullable
                                    String indexAnalyzer,
                                    @Nullable
                                    String indexTemplateName,
                                    @Nullable
                                    String indexTemplateType,
                                    @Nullable
                                    Integer maxNumSegments,
                                    @Nullable
                                    Boolean indexOptimizationDisabled,
                                    @Nullable
                                    org.joda.time.Duration fieldTypeRefreshInterval)

create

public static IndexSetConfig create(String id,
                                    String title,
                                    String description,
                                    boolean isWritable,
                                    Boolean isRegular,
                                    String indexPrefix,
                                    int shards,
                                    int replicas,
                                    String rotationStrategyClass,
                                    RotationStrategyConfig rotationStrategy,
                                    String retentionStrategyClass,
                                    RetentionStrategyConfig retentionStrategy,
                                    ZonedDateTime creationDate,
                                    String indexAnalyzer,
                                    String indexTemplateName,
                                    String indexTemplateType,
                                    int indexOptimizationMaxNumSegments,
                                    boolean indexOptimizationDisabled)

create

public static IndexSetConfig create(String title,
                                    String description,
                                    boolean isWritable,
                                    Boolean isRegular,
                                    String indexPrefix,
                                    int shards,
                                    int replicas,
                                    String rotationStrategyClass,
                                    RotationStrategyConfig rotationStrategy,
                                    String retentionStrategyClass,
                                    RetentionStrategyConfig retentionStrategy,
                                    ZonedDateTime creationDate,
                                    String indexAnalyzer,
                                    String indexTemplateName,
                                    String indexTemplateType,
                                    int indexOptimizationMaxNumSegments,
                                    boolean indexOptimizationDisabled)

compareTo

public int compareTo(IndexSetConfig o)

Specified by:

compareTo in interface Comparable<IndexSetConfig>

toBuilder

public abstract IndexSetConfig.Builder toBuilder()

builder

public static IndexSetConfig.Builder builder()