Package 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>

  • Field Details

  • Constructor Details

    • IndexSetConfig

      public IndexSetConfig()

  • Method Details

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

    • shards

      @Min(1L) public abstract @javax.validation.constraints.Min(1L) int shards()

    • replicas

      @Min(0L) public abstract @javax.validation.constraints.Min(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(1L) public abstract @javax.validation.constraints.Min(1L) int indexOptimizationMaxNumSegments()

    • indexOptimizationDisabled

      public abstract boolean indexOptimizationDisabled()

    • fieldTypeRefreshInterval

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

    • customFieldMappings

      public abstract CustomFieldMappings customFieldMappings()

    • 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(1L) @javax.validation.constraints.Min(1L) int shards, @Min(0L) @javax.validation.constraints.Min(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, @Nullable CustomFieldMappings customFieldMappings)

    • 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()
      For non-UI originating instances, use IndexSetConfigFactory instead to create an instance with appropriate defaults.