Package org.graylog2.indexer.indexset.template

Record Class IndexSetTemplate

java.lang.Object

java.lang.Record

org.graylog2.indexer.indexset.template.IndexSetTemplate

All Implemented Interfaces:

MongoEntity

public record IndexSetTemplate(@Nullable String id, @Nonnull String title, String description, boolean isBuiltIn, @Nonnull IndexSetTemplateConfig indexSetConfig)
extends Record
implements MongoEntity

Represents template as it is stored in Mongo.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUILT_IN_FIELD_NAME
static final String	DESCRIPTION_FIELD_NAME
static final String	ID_FIELD_NAME
static final String	INDEX_SET_CONFIG_FIELD_NAME
static final String	TITLE_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
IndexSetTemplate(String id, String title, String description, boolean isBuiltIn, IndexSetTemplateConfig indexSetConfig)	Creates an instance of a IndexSetTemplate record class.
IndexSetTemplate(IndexSetTemplateRequest data)

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
IndexSetTemplateConfig	indexSetConfig()	Returns the value of the indexSetConfig record component.
boolean	isBuiltIn()	Returns the value of the isBuiltIn record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ID_FIELD_NAME

public static final String ID_FIELD_NAME

See Also:

• Constant Field Values

TITLE_FIELD_NAME

public static final String TITLE_FIELD_NAME

See Also:

• Constant Field Values

DESCRIPTION_FIELD_NAME

public static final String DESCRIPTION_FIELD_NAME

See Also:

• Constant Field Values

BUILT_IN_FIELD_NAME

public static final String BUILT_IN_FIELD_NAME

See Also:

• Constant Field Values

INDEX_SET_CONFIG_FIELD_NAME

public static final String INDEX_SET_CONFIG_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

IndexSetTemplate

public IndexSetTemplate(IndexSetTemplateRequest data)

IndexSetTemplate

public IndexSetTemplate(@Nullable
 String id,
 @Nonnull
 String title,
 String description,
 boolean isBuiltIn,
 @Nonnull
 IndexSetTemplateConfig indexSetConfig)

Creates an instance of a IndexSetTemplate record class.

Parameters:

id - the value for the id record component

title - the value for the title record component

description - the value for the description record component

isBuiltIn - the value for the isBuiltIn record component

indexSetConfig - the value for the indexSetConfig record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

@Nullable
public String id()

Returns the value of the id record component.

Specified by:

id in interface MongoEntity

Returns:

the value of the id record component

title

@Nonnull
public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

isBuiltIn

public boolean isBuiltIn()

Returns the value of the isBuiltIn record component.

Returns:

the value of the isBuiltIn record component

indexSetConfig

@Nonnull
public IndexSetTemplateConfig indexSetConfig()

Returns the value of the indexSetConfig record component.

Returns:

the value of the indexSetConfig record component