org.graylog2.indexer

Class IgnoreIndexTemplate

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.graylog2.indexer.IgnoreIndexTemplate

All Implemented Interfaces:

Serializable

public class IgnoreIndexTemplate
extends RuntimeException

This exception, when thrown by an implementation of IndexTemplateProvider, indicates that index template is not required for the current index rotation cycle It might be useful in the following scenarios: 1) index template is managed externally 2) index template cannot be resolved at the moment and it's acceptable to proceed with an already existing template in Elasticsearch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IgnoreIndexTemplate(boolean failOnMissingTemplate, String reason, String indexPrefix, String indexTemplateName, String indexTemplateType)

Method Summary

Modifier and Type	Method and Description
String	getIndexTemplateName()
boolean	isFailOnMissingTemplate()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnoreIndexTemplate

public IgnoreIndexTemplate(boolean failOnMissingTemplate,
                           @Nonnull
                           String reason,
                           @Nonnull
                           String indexPrefix,
                           @Nonnull
                           String indexTemplateName,
                           @Nullable
                           String indexTemplateType)

Parameters:

failOnMissingTemplate - indicates whether the index rotation cycle should fail if this template has not been found in Elasticsearch

reason - indicates the reason for which the index template cannot be resolved

Method Detail

isFailOnMissingTemplate

public boolean isFailOnMissingTemplate()

getIndexTemplateName

public String getIndexTemplateName()