Package org.graylog2.rest.resources.system.indexer.responses

Class IndexSetSummary

java.lang.Object

org.graylog2.rest.resources.system.indexer.responses.IndexSetSummary

All Implemented Interfaces:

SimpleIndexSetConfig

public abstract class IndexSetSummary
extends Object
implements SimpleIndexSetConfig

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_CAN_BE_DEFAULT
static final String	FIELD_DATA_TIERING_STATUS
static final String	FIELD_DEFAULT

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

Method Summary

Modifier and Type	Method	Description
abstract boolean	canBeDefault()
static IndexSetSummary	create(String id, @NotBlank String title, String description, boolean isDefault, boolean isWritable, boolean canBeDefault, @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String indexPrefix, @jakarta.validation.constraints.Min(1L) int shards, @jakarta.validation.constraints.Min(0L) int replicas, @NotNull String rotationStrategyClass, @NotNull RotationStrategyConfig rotationStrategy, @NotNull String retentionStrategyClass, @NotNull RetentionStrategyConfig retentionStrategy, ZonedDateTime creationDate, @NotBlank String indexAnalyzer, @jakarta.validation.constraints.Min(1L) int indexOptimizationMaxNumSegments, boolean indexOptimizationDisabled, org.joda.time.Duration fieldTypeRefreshInterval, String templateType, String fieldTypeProfile, DataTieringConfig dataTiering, Boolean useLegacyRotation, DataTieringStatus dataTieringStatus)
abstract @NotNull ZonedDateTime	creationDate()
abstract DataTieringStatus	dataTieringStatus()
abstract String	description()
abstract String	fieldTypeProfile()
abstract org.joda.time.Duration	fieldTypeRefreshInterval()
static IndexSetSummary	fromIndexSetConfig(IndexSetConfig indexSet, boolean isDefault)
static IndexSetSummary	fromIndexSetConfig(IndexSetConfig indexSet, boolean isDefault, DataTieringStatus dataTieringStatus)
abstract String	id()
abstract @NotBlank String	indexAnalyzer()
abstract boolean	indexOptimizationDisabled()
abstract @jakarta.validation.constraints.Min(1L) int	indexOptimizationMaxNumSegments()
abstract @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 boolean	isDefault()
abstract boolean	isWritable()
abstract Optional<String>	templateType()
abstract @NotBlank String	title()
IndexSetConfig	toIndexSetConfig(boolean isRegular)
abstract Boolean	useLegacyRotation()

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, replicas, retentionStrategyClass, retentionStrategyConfig, rotationStrategyClass, rotationStrategyConfig, shards

Field Details

FIELD_DEFAULT

public static final String FIELD_DEFAULT

See Also:

• Constant Field Values

FIELD_CAN_BE_DEFAULT

public static final String FIELD_CAN_BE_DEFAULT

See Also:

• Constant Field Values

FIELD_DATA_TIERING_STATUS

public static final String FIELD_DATA_TIERING_STATUS

See Also:

• Constant Field Values

Constructor Details

IndexSetSummary

public IndexSetSummary()

Method Details

create

public static IndexSetSummary create(@Nullable
 String id,
 @NotBlank
 @NotBlank String title,
 @Nullable
 String description,
 boolean isDefault,
 boolean isWritable,
 boolean canBeDefault,
 @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$")
 @Pattern(regexp="^[a-z0-9][a-z0-9_+-]*$") String indexPrefix,
 @Min(1L)
 @jakarta.validation.constraints.Min(1L) int shards,
 @Min(0L)
 @jakarta.validation.constraints.Min(0L) int replicas,
 @NotNull
 @NotNull String rotationStrategyClass,
 @NotNull
 @NotNull RotationStrategyConfig rotationStrategy,
 @NotNull
 @NotNull String retentionStrategyClass,
 @NotNull
 @NotNull RetentionStrategyConfig retentionStrategy,
 @Nullable
 ZonedDateTime creationDate,
 @NotBlank
 @NotBlank String indexAnalyzer,
 @Min(1L)
 @jakarta.validation.constraints.Min(1L) int indexOptimizationMaxNumSegments,
 boolean indexOptimizationDisabled,
 org.joda.time.Duration fieldTypeRefreshInterval,
 @Nullable
 String templateType,
 @Nullable
 String fieldTypeProfile,
 @Nullable
 DataTieringConfig dataTiering,
 @Nullable
 Boolean useLegacyRotation,
 @Nullable
 DataTieringStatus dataTieringStatus)

fromIndexSetConfig

public static IndexSetSummary fromIndexSetConfig(IndexSetConfig indexSet,
 boolean isDefault)

fromIndexSetConfig

public static IndexSetSummary fromIndexSetConfig(IndexSetConfig indexSet,
 boolean isDefault,
 DataTieringStatus dataTieringStatus)

id

@Nullable
public abstract String id()

title

@NotBlank
public abstract @NotBlank String title()

description

@Nullable
public abstract String description()

isDefault

public abstract boolean isDefault()

canBeDefault

public abstract boolean canBeDefault()

isWritable

public abstract boolean isWritable()

indexPrefix

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

creationDate

@NotNull
public abstract @NotNull ZonedDateTime creationDate()

indexAnalyzer

@NotBlank
public abstract @NotBlank String indexAnalyzer()

indexOptimizationMaxNumSegments

@Min(1L)
public abstract @jakarta.validation.constraints.Min(1L) int indexOptimizationMaxNumSegments()

Specified by:

indexOptimizationMaxNumSegments in interface SimpleIndexSetConfig

indexOptimizationDisabled

public abstract boolean indexOptimizationDisabled()

Specified by:

indexOptimizationDisabled in interface SimpleIndexSetConfig

fieldTypeRefreshInterval

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

Specified by:

fieldTypeRefreshInterval in interface SimpleIndexSetConfig

templateType

public abstract Optional<String> templateType()

fieldTypeProfile

@Nullable
public abstract String fieldTypeProfile()

useLegacyRotation

@Nullable
public abstract Boolean useLegacyRotation()

dataTieringStatus

@Nullable
public abstract DataTieringStatus dataTieringStatus()

toIndexSetConfig

public IndexSetConfig toIndexSetConfig(boolean isRegular)