@ExperimentalApi public class

IndexDocumentConfiguration

extends Object
java.lang.Object
   ↳ com.atlassian.jira.index.IndexDocumentConfiguration

@ExperimentalApi

This class is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Document that configures indexing of entityProperties it reads to description in format of: <key entity-key="com.atlassian.jira.thing"> <extract path="foo.bar" type="string"> <!-- "path" tells you what part of the json to extract. "type" could be "number", "string", "text", "date" and tells you how to analyse it --> </<extract> </key> <key prefix="com.atlassian.jira.rank"> <extract...><extract/> </key>

Summary

Nested Classes
class IndexDocumentConfiguration.ConfigurationElement  
class IndexDocumentConfiguration.ExtractConfiguration  
class IndexDocumentConfiguration.KeyConfiguration  
enum IndexDocumentConfiguration.Type  
Public Constructors
IndexDocumentConfiguration(String entityKey, List<IndexDocumentConfiguration.KeyConfiguration> keyConfigurations)
Public Methods
boolean equals(Object o)
Iterable<IndexDocumentConfiguration.ConfigurationElement> getConfigurationElements()
String getEntityKey()
List<IndexDocumentConfiguration.KeyConfiguration> getKeyConfigurations()
List of key that are defined to be scanned in this configuration
int hashCode()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public IndexDocumentConfiguration (String entityKey, List<IndexDocumentConfiguration.KeyConfiguration> keyConfigurations)

Public Methods

public boolean equals (Object o)

public Iterable<IndexDocumentConfiguration.ConfigurationElement> getConfigurationElements ()

public String getEntityKey ()

Returns
  • name of entity associated with this configuration

public List<IndexDocumentConfiguration.KeyConfiguration> getKeyConfigurations ()

List of key that are defined to be scanned in this configuration

Returns
  • list of key configurations

public int hashCode ()

public String toString ()