elasticmagic/dev.evo.elasticmagic

Package-level declarations

Types

data class AsyncResult<P, T>(val task: String, val createStatus: (Deserializer.ObjectCtx) -> P, val createResponse: (Deserializer.ObjectCtx) -> T)

BaseSearchQuery

abstract class BaseSearchQuery<S : BaseDocSource, T : BaseSearchQuery<S, T>>(docSourceFactory: (obj: Deserializer.ObjectCtx) -> S, query: QueryExpression? = null, params: Params = Params())

An abstract class that holds all the search query builder methods. Inheritors of the class can implement some shortcut methods. For instance SearchQuery.execute which can be suspendable or blocking.

BulkError

data class BulkError(val type: String, val reason: String, val index: String, val indexUuid: String, val shard: Int?)

BulkItem

sealed class BulkItem

BulkOpType

enum BulkOpType : Enum<BulkOpType>

BulkResult

data class BulkResult(val errors: Boolean, val took: Long, val items: List<BulkItem>)

BulkScrollFailure

data class BulkScrollFailure(val index: String, val type: String?, val id: String, val status: Int, val cause: BulkError)

BulkScrollRetries

data class BulkScrollRetries(val bulk: Long, val search: Long)

Conflicts

enum Conflicts : Enum<Conflicts> , ToValue<String>

Action on conflicts.

CountResult

data class CountResult(val count: Long)

CreateIndexResult

data class CreateIndexResult(val acknowledged: Boolean, val shardsAcknowledged: Boolean, val index: String)

DeleteByQueryPartialResult

typealias DeleteByQueryPartialResult = UpdateByQueryPartialResult

DeleteByQueryResult

data class DeleteByQueryResult(val took: Long, val timedOut: Boolean, val total: Long, val deleted: Long, val batches: Int, val versionConflicts: Long, val noops: Long, val retries: BulkScrollRetries, val throttledMillis: Long, val requestsPerSecond: Float, val throttledUntilMillis: Long, val failures: List<BulkScrollFailure>)

DeleteIndexResult

data class DeleteIndexResult(val acknowledged: Boolean)

ElasticsearchCluster

class ElasticsearchCluster(val transport: ElasticsearchTransport, val apiSerde: Serde, val bulkSerde: Serde.OneLineJson, compilers: CompilerSet? = null)

ElasticsearchIndex

class ElasticsearchIndex(val name: String, val cluster: ElasticsearchCluster)

Explanation

data class Explanation(val value: Float, val description: String, val details: List<Explanation> = emptyList())

MultiSearchQueryResult

data class MultiSearchQueryResult(val took: Long?, val responses: List<SearchQueryResult<BaseDocSource>>)

MutableParams

typealias MutableParams = MutableMap<String, Any>

Params

typealias Params = Map<String, Any>

PingResult

data class PingResult(val statusCode: Int, val responseTimeMs: Long)

PreparedSearchQuery

interface PreparedSearchQuery

Refresh

enum Refresh : Enum<Refresh> , ToValue<String>

Refresh controls when changes will be searchable.

SearchHit

data class SearchHit<S : BaseDocSource>(val index: String, val type: String, val id: String, val routing: String? = null, val version: Long? = null, val seqNo: Long? = null, val primaryTerm: Long? = null, val score: Float? = null, val sort: List<Any?>? = null, val source: S? = null, val fields: SearchHit.Fields = Fields(emptyMap()), val explanation: Explanation? = null) : ActionMeta

SearchQuery

open class SearchQuery<S : BaseDocSource>(docSourceFactory: (obj: Deserializer.ObjectCtx) -> S, query: QueryExpression? = null, params: Params = Params()) : BaseSearchQuery<S, SearchQuery<S>>

An asynchronous version of search query.

SearchQueryResult

data class SearchQueryResult<S : BaseDocSource>(val rawResult: Map<String, Any?>?, val took: Long, val timedOut: Boolean, val totalHits: Long?, val totalHitsRelation: String?, val maxScore: Float?, val hits: List<SearchHit<S>>, val aggs: Map<String, AggregationResult>) : AggAwareResult

SearchType

enum SearchType : Enum<SearchType> , ToValue<String>

TaskInfo

data class TaskInfo<T>(val node: String, val id: Long, val type: String, val action: String, val status: T, val description: String, val startTimeInMillis: Long, val runningTimeInNanos: Long, val cancellable: Boolean)

TaskResult

data class TaskResult<P, T>(val completed: Boolean, val task: TaskInfo<P>, val response: T)

ToValue

interface ToValue<T>

UpdateByQueryPartialResult

data class UpdateByQueryPartialResult(val total: Long, val updated: Long, val created: Long, val deleted: Long, val batches: Int, val versionConflicts: Long, val noops: Long, val retries: BulkScrollRetries, val throttledMillis: Long, val requestsPerSecond: Float, val throttledUntilMillis: Long)

UpdateByQueryResult

data class UpdateByQueryResult(val took: Long, val timedOut: Boolean, val total: Long, val updated: Long, val deleted: Long, val batches: Int, val versionConflicts: Long, val noops: Long, val retries: BulkScrollRetries, val throttledMillis: Long, val requestsPerSecond: Float, val throttledUntilMillis: Long, val failures: List<BulkScrollFailure>)

UpdateMappingResult

data class UpdateMappingResult(val acknowledged: Boolean)

Version

sealed class Version<T : Version<T>> : Comparable<T>

WithIndex

data class WithIndex<out T>(val indexName: String, val request: T)

Functions

Params

fun Params(): Params

fun Params(vararg entries: Pair<String, Any?>): Params

fun Params(params: Params, others: Params?): Params

fun Params(params: Params?, vararg entries: Pair<String, Any?>): Params

withIndex

fun <T> T.withIndex(indexName: String): WithIndex<T>