Package com.atlassian.jira.search.index

Interface IndexSchema

All Superinterfaces:

Schema

All Known Implementing Classes:

DefaultIndexSchema

@PublicApi
public interface IndexSchema
extends Schema

Represents the schema of search index. It contains fields and their type information that can't be changed after creation. As such the schema is meant to be persisted.

Since:

10.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IndexSchema.Builder	Builder for IndexSchema

Method Summary

Modifier and Type	Method	Description
String	getIndexName()	Retrieve the name of the index.
IndexSchema.Builder	toBuilder()
LongField	version()

Methods inherited from interface com.atlassian.jira.search.Schema

accept, getField, getFieldAt, getFields, isDefined, isDefined

Method Details

version

LongField version()

Returns:

version field. A version is a number starting from 0

getIndexName

String getIndexName()

Retrieve the name of the index.

Returns:

the index name

toBuilder

IndexSchema.Builder toBuilder()

Returns:

a IndexSchema builder populated with values from the current instance