Package com.atlassian.confluence.search.v2

Class AtlassianDocument

java.lang.Object

com.atlassian.confluence.search.v2.AtlassianDocument

public class AtlassianDocument
extends Object

Since:

7.16

Constructor Summary

Constructors

Constructor	Description
AtlassianDocument()
AtlassianDocument(Collection<FieldDescriptor> fields)

Method Summary

Modifier and Type	Method	Description
AtlassianDocument	addField(FieldDescriptor field)
AtlassianDocument	addFields(Collection<FieldDescriptor> fields)
Collection<FieldDescriptor>	getFields()
@Nullable String	getId()	Returns the id that uniquely identifies this document on the index, or null if this document is to be indexed with an auto-generated id.
Optional<String>	getValue(String fieldName)
AtlassianDocument	setId(@Nullable String id)	Sets an (optional) id that uniquely identifies this document on the index.

Methods inherited from class java.lang.Object

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

Constructor Details

AtlassianDocument

public AtlassianDocument()

AtlassianDocument

public AtlassianDocument(Collection<FieldDescriptor> fields)

Method Details

addField

public AtlassianDocument addField(FieldDescriptor field)

addFields

public AtlassianDocument addFields(Collection<FieldDescriptor> fields)

getFields

public Collection<FieldDescriptor> getFields()

getValue

public Optional<String> getValue(String fieldName)

getId

public @Nullable String getId()

Returns the id that uniquely identifies this document on the index, or null if this document is to be indexed with an auto-generated id.

Only available in OpenSearch. This property is ignored on Lucene.

Returns:

the id that uniquely identifies this document on the index, or null if this document is to be indexed with an auto-generated id.

Since:

8.8

setId

@ExperimentalApi
public AtlassianDocument setId(@Nullable String id)

Sets an (optional) id that uniquely identifies this document on the index. If null, an internal id will be auto-generated.

Only available in OpenSearch. This property is ignored on Lucene.

Parameters:

id - String | the id that uniquely identifies this document on the index

Since:

8.8