Package org.graylog2.indexer.indexset

Class IndexSetConfig

java.lang.Object

org.graylog2.indexer.indexset.IndexSetConfig

All Implemented Interfaces:

Comparable<IndexSetConfig>, SimpleIndexSetConfig

public abstract class IndexSetConfig
extends Object
implements Comparable<IndexSetConfig>, SimpleIndexSetConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexSetConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_INDEX_TEMPLATE_TYPE
static final String	FIELD_CUSTOM_FIELD_MAPPINGS
static final String	FIELD_INDEX_MATCH_PATTERN
static final String	FIELD_INDEX_TEMPLATE_NAME
static final String	FIELD_INDEX_WILDCARD
static final String	FIELD_REGULAR

Fields inherited from interface org.graylog2.indexer.indexset.SimpleIndexSetConfig

DEFAULT_FIELD_TYPE_REFRESH_INTERVAL, FIELD_CREATION_DATE, FIELD_DATA_TIERING, FIELD_DESCRIPTION, FIELD_INDEX_ANALYZER, FIELD_INDEX_OPTIMIZATION_DISABLED, FIELD_INDEX_OPTIMIZATION_MAX_NUM_SEGMENTS, FIELD_INDEX_PREFIX, FIELD_INDEX_TEMPLATE_TYPE, FIELD_PROFILE_ID, FIELD_REPLICAS, FIELD_RETENTION_STRATEGY, FIELD_RETENTION_STRATEGY_CLASS, FIELD_ROTATION_STRATEGY, FIELD_ROTATION_STRATEGY_CLASS, FIELD_SHARDS, FIELD_TITLE, FIELD_TYPE_REFRESH_INTERVAL, FIELD_USE_LEGACY_ROTATION, FIELD_WRITABLE, INDEX_PREFIX_REGEX

Constructor Summary

Constructors

Constructor	Description
IndexSetConfig()

Method Summary

Modifier and Type	Method	Description
static IndexSetConfig.Builder	builder()	For non-UI originating instances, use IndexSetConfigFactory instead to create an instance with appropriate defaults.
boolean	canHaveCustomFieldMappings()
boolean	canHaveProfile()
int	compareTo(IndexSetConfig o)
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, @jakarta.validation.constraints.Min(1L) int shards, @jakarta.validation.constraints.Min(0L) int replicas, String rotationStrategyClass, RotationStrategyConfig rotationStrategy, String retentionStrategyClass, RetentionStrategyConfig retentionStrategy, @NotNull ZonedDateTime creationDate, String indexAnalyzer, String indexTemplateName, String indexTemplateType, Integer maxNumSegments, Boolean indexOptimizationDisabled, org.joda.time.Duration fieldTypeRefreshInterval, CustomFieldMappings customFieldMappings, @ValidObjectId String fieldTypeProfile, DataTieringConfig dataTiering)
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)
abstract @NotNull ZonedDateTime	creationDate()
abstract CustomFieldMappings	customFieldMappings()
abstract String	description()
abstract String	fieldTypeProfile()
abstract String	id()
abstract @NotBlank String	indexAnalyzer()
abstract String	indexMatchPattern()
abstract @NotBlank @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") @SizeInBytes(message="Index prefix must have a length in bytes between {min} and {max}",min=1,max=250) 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 @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

Methods inherited from interface org.graylog2.indexer.indexset.SimpleIndexSetConfig

dataTieringConfig, fieldTypeRefreshInterval, indexOptimizationDisabled, indexOptimizationMaxNumSegments, replicas, retentionStrategyClass, retentionStrategyConfig, rotationStrategyClass, rotationStrategyConfig, shards

Field Details

DEFAULT_INDEX_TEMPLATE_TYPE

public static final String DEFAULT_INDEX_TEMPLATE_TYPE

See Also:

• Constant Field Values

FIELD_REGULAR

public static final String FIELD_REGULAR

See Also:

• Constant Field Values

FIELD_INDEX_MATCH_PATTERN

public static final String FIELD_INDEX_MATCH_PATTERN

See Also:

• Constant Field Values

FIELD_INDEX_WILDCARD

public static final String FIELD_INDEX_WILDCARD

See Also:

• Constant Field Values

FIELD_INDEX_TEMPLATE_NAME

public static final String FIELD_INDEX_TEMPLATE_NAME

See Also:

• Constant Field Values

FIELD_CUSTOM_FIELD_MAPPINGS

public static final String FIELD_CUSTOM_FIELD_MAPPINGS

See Also:

• Constant Field Values

Constructor Details

IndexSetConfig

public IndexSetConfig()

Method Details

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(1L)
 @jakarta.validation.constraints.Min(1L) int shards,
 @Min(0L)
 @jakarta.validation.constraints.Min(0L) int replicas,
 @Nullable
 String rotationStrategyClass,
 @Nullable
 RotationStrategyConfig rotationStrategy,
 @Nullable
 String retentionStrategyClass,
 @Nullable
 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,
 @Nullable
 CustomFieldMappings customFieldMappings,
 @ValidObjectId @Nullable
 @ValidObjectId String fieldTypeProfile,
 @Nullable
 DataTieringConfig dataTiering)

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)

builder

public static IndexSetConfig.Builder builder()

For non-UI originating instances, use IndexSetConfigFactory instead to create an instance with appropriate defaults.

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_+-]*$")
@SizeInBytes(message="Index prefix must have a length in bytes between {min} and {max}",
             min=1,
             max=250)
public abstract @NotBlank @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") @SizeInBytes(message="Index prefix must have a length in bytes between {min} and {max}",min=1,max=250) String indexPrefix()

indexMatchPattern

@Nullable
public abstract String indexMatchPattern()

indexWildcard

@Nullable
public abstract String indexWildcard()

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()

customFieldMappings

public abstract CustomFieldMappings customFieldMappings()

fieldTypeProfile

@Nullable
public abstract String fieldTypeProfile()

isRegularIndex

public boolean isRegularIndex()

canHaveCustomFieldMappings

public boolean canHaveCustomFieldMappings()

canHaveProfile

public boolean canHaveProfile()

compareTo

public int compareTo(IndexSetConfig o)

Specified by:

compareTo in interface Comparable<IndexSetConfig>

toBuilder

public abstract IndexSetConfig.Builder toBuilder()