Package-level declarations

Types

Link copied to clipboard
sealed class Action<S>

Base bulk action class.

Link copied to clipboard
interface ActionMeta

Bulk action metadata.

Link copied to clipboard

Controls optimistic concurrency.

Link copied to clipboard
class CreateAction<S : BaseDocSource>(meta: ActionMeta, source: S, pipeline: String? = null, concurrencyControl: ConcurrencyControl? = null) : IndexAction<S>

Creates new source document in an index. If the document already exists, the action fails.

Link copied to clipboard
class DeleteAction(val meta: IdActionMeta, val concurrencyControl: ConcurrencyControl? = null) : Action<Nothing>

Removes a document specified by an meta's id from an index.

Link copied to clipboard
class DocSourceAndMeta<M : ActionMeta>(val meta: M, val doc: BaseDocSource)

Combines a document source with its action metadata.

Link copied to clipboard

Bulk action metadata with mandatory id.

Link copied to clipboard
open class IndexAction<S : BaseDocSource>(val meta: ActionMeta, val source: S, val concurrencyControl: ConcurrencyControl? = null, val pipeline: String? = null) : Action<S>

Indexes a source document to an index. If the document already exists, the action overwrites the document and increments its version.

Link copied to clipboard
class UpdateAction<S : BaseDocSource>(val meta: IdActionMeta, val source: UpdateSource<S>, val retryOnConflict: Int? = null, val concurrencyControl: ConcurrencyControl? = null) : Action<UpdateSource<S>>

Updates a document specified by an meta's id.

Link copied to clipboard
sealed class UpdateSource<S : BaseDocSource>

Represents an update action's source. Has 2 flavors:

Functions

Link copied to clipboard
fun BaseDocSource.withActionMeta(routing: String? = null, version: Long? = null, seqNo: Long? = null, primaryTerm: Long? = null): DocSourceAndMeta<ActionMeta>
fun BaseDocSource.withActionMeta(id: String, routing: String? = null, version: Long? = null, seqNo: Long? = null, primaryTerm: Long? = null): DocSourceAndMeta<IdActionMeta>

A shortcut to attach action metadata to a document source.