search-client/com.jillesvangurp.ktsearch

Package-level declarations

Types

@Serializable

data class AcknowledgedResponse(val acknowledged: Boolean)

class AffinityId(val affinityId: String) : AbstractCoroutineContextElement

Use this co routine scope to control affinity to a particular host. Ktor client may attempt to pipeline/reuse connections depending on how you set that up.

Aggregations

typealias Aggregations = JsonObject

AliasAction

class AliasAction : JsonDsl

AliasResponse

@Serializable

data class AliasResponse(val aliases: Map<String, JsonObject>)

AliasUpdateRequest

class AliasUpdateRequest : JsonDsl

DSL for configuring the update aliases request. The request is a list of actions (add, remove, remove_index). Each action is configured with an AliasAction that specifies the affected indices, aliases, etc.

AnalyzeRequest

class AnalyzeRequest : JsonDsl

AnalyzeResponse

@Serializable

data class AnalyzeResponse(val tokens: List<AnalyzeToken>)

AnalyzeToken

@Serializable

data class AnalyzeToken(val token: String, val startOffset: Int, val endOffset: Int, val type: String, val position: Int)

Bucket

class Bucket<T>(val aggregations: Aggregations, deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON)

BucketAggregationResult

interface BucketAggregationResult<T>

BulkException

class BulkException(val bulkResponse: BulkResponse) : Exception

BulkItemCallBack

interface BulkItemCallBack

Use this to deal with item responses and failures; or bulk request errors. By default, the callback is null.

BulkResponse

@Serializable

data class BulkResponse(val took: Long, val errors: Boolean, val items: List<JsonObject>)

BulkSession

interface BulkSession

ClusterHealthResponse

@Serializable

data class ClusterHealthResponse(val clusterName: String, val status: ClusterStatus, val timedOut: Boolean)

ClusterStatus

@Serializable

enum ClusterStatus : Enum<ClusterStatus>

ComponentTemplate

class ComponentTemplate : JsonDsl

CountResponse

@Serializable

data class CountResponse(val count: Long, val shards: Shards)

CreatePointInTimeResponse

@Serializable

data class CreatePointInTimeResponse(val id: String)

DateHistogramAggregationResult

@Serializable

data class DateHistogramAggregationResult(val buckets: List<JsonObject>) : BucketAggregationResult<DateHistogramBucket>

DateHistogramBucket

@Serializable

data class DateHistogramBucket(val key: Long, val keyAsString: String, val docCount: Long)

DateRangesAggregationResult

@Serializable

data class DateRangesAggregationResult(val buckets: List<JsonObject>) : BucketAggregationResult<DateRangesBucket>

DateRangesBucket

@Serializable

data class DateRangesBucket(val key: String, val docCount: Long, val from: Double?, val fromAsString: String?, val to: Double?, val toAsString: String?)

DeleteByQueryResponse

@Serializable

data class DeleteByQueryResponse(val took: Long, val timedOut: Boolean, val total: Long, val deleted: Long, val batches: Long, val versionConflicts: Long, val noops: Long, val retries: DeleteByQueryResponse.Retries, val requestsPerSecond: Double, val throttledUntilMillis: Long, val failures: List<JsonObject>? = null)

DocumentIndexResponse

@Serializable

data class DocumentIndexResponse(val index: String, val type: String?, val id: String, val version: Long, val result: String, val shards: Shards, val seqNo: Long, val primaryTerm: Long, val source: JsonObject? = null) : SourceInformation

DocumentUpdateResponse

@Serializable

data class DocumentUpdateResponse(val index: String, val type: String?, val id: String, val version: Long, val result: String, val shards: Shards, val seqNo: Long, val primaryTerm: Long, val get: DocumentUpdateResponse.UpdatedSourceInformation? = null)

DoubleValueAggregationResult

@Serializable

data class DoubleValueAggregationResult(val value: Double, val valueAsString: String?)

ExpandWildCards

enum ExpandWildCards : Enum<ExpandWildCards>

ExtendedStatsBucketResult

@Serializable

data class ExtendedStatsBucketResult(val count: Int = 0, val min: Double = 0.0, val max: Double = 0.0, val avg: Double = 0.0, val sum: Double = 0.0, val sumOfSquares: Double = 0.0, val variance: Double = 0.0, val variancePopulation: Double = 0.0, val varianceSampling: Double = 0.0, val stdDeviation: Double = 0.0, val stdDeviationPopulation: Double = 0.0, val stdDeviationSampling: Double = 0.0, val stdDeviationBounds: ExtendedStatsBucketResult.Bounds = Bounds())

FilterAggregationResult

@Serializable

data class FilterAggregationResult(val docCount: Long)

FilterBucket

data class FilterBucket(val name: String, val docCount: Long, val bucket: JsonObject)

FiltersAggregationResult

@Serializable

data class FiltersAggregationResult(val buckets: JsonObject)

GeoCentroidResult

@Serializable

data class GeoCentroidResult(val location: GeoCentroidResult.Point, val count: Long)

GeoTileGridBucket

@Serializable

data class GeoTileGridBucket(val key: String, val docCount: Long)

GeoTileGridResult

@Serializable

data class GeoTileGridResult(val buckets: List<JsonObject>) : BucketAggregationResult<GeoTileGridBucket>

GetDocumentResponse

@Serializable

data class GetDocumentResponse(val index: String, val type: String?, val id: String, val version: Long?, val source: JsonObject?, val seqNo: Long?, val primaryTerm: Long?, val found: Boolean, val routing: String? = null, val fields: JsonObject? = null) : SourceInformation

HitsContainer

@Serializable

class HitsContainer(val hits: SearchResponse.Hits)

HttpMethod

data class HttpMethod(val value: String)

ILMActions

class ILMActions : JsonDsl

ILMConfiguration

class ILMConfiguration : JsonDsl

ILMPhaseConfiguration

class ILMPhaseConfiguration : JsonDsl

IMLPhases

class IMLPhases : JsonDsl

IMLPolicy

class IMLPolicy : JsonDsl

IndexCreateResponse

@Serializable

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

IndexProvider

interface IndexProvider

IndexTemplate

class IndexTemplate : JsonDsl

KtorRestClient

class KtorRestClient(nodes: Node = arrayOf( Node( "localhost", 9200 ) ), https: Boolean = false, user: String? = null, password: String? = null, logging: Boolean = false, nodeSelector: NodeSelector = RoundRobinNodeSelector(nodes), elasticApiKey: String? = null, client: HttpClient = defaultKtorHttpClient( logging = logging, user = user, password = password, elasticApiKey = elasticApiKey ) { defaultInit(logging, user, password, elasticApiKey) }) : RestClient, Closeable

Ktor-client implementation of the RestClient.

LongValueAggregationResult

@Serializable

data class LongValueAggregationResult(val value: Long, val valueAsString: String?)

MatchedQueries

typealias MatchedQueries = JsonElement

MGetRequest

class MGetRequest : JsonDsl

MGetResponse

@Serializable

data class MGetResponse(val docs: List<GetDocumentResponse>)

MsearchHeader

class MsearchHeader : JsonDsl

MsearchRequest

class MsearchRequest

MultiSearchResponse

@Serializable

data class MultiSearchResponse(val took: Long, val responses: List<SearchResponse>)

Node

data class Node(val host: String, val port: Int?)

NodeSelector

interface NodeSelector

OperationType

enum OperationType : Enum<OperationType>

RangesAggregationResult

@Serializable

data class RangesAggregationResult(val buckets: List<JsonObject>) : BucketAggregationResult<RangesBucket>

RangesBucket

@Serializable

data class RangesBucket(val key: String, val docCount: Long, val from: Double?, val to: Double?)

Refresh

enum Refresh : Enum<Refresh>

ReindexResponse

@Serializable

data class ReindexResponse(val took: Int, val timedOut: Boolean, val total: Int, val updated: Int, val created: Int, val deleted: Int, val batches: Int, val versionConflicts: Int, val noops: Int, val retries: ReindexRetries, val throttledMillis: Int, val requestsPerSecond: Double, val throttledUntilMillis: Int, val failures: List<String>)

ReindexRetries

@Serializable

data class ReindexRetries(val bulk: Int, val search: Int)

RestClient

interface RestClient

Minimalistic abstraction that should allow for different clients.

RestException

class RestException(val response: RestResponse) : Exception

RestResponse

sealed class RestResponse

RoundRobinNodeSelector

class RoundRobinNodeSelector(nodes: Array<out Node>) : NodeSelector

SearchAPIRequest

data class SearchAPIRequest(body: String? = null, contentType: String = "application/json", pathComponents: List<String> = listOf(), parameters: MutableMap<String, String> = mutableMapOf(), headers: MutableMap<String, Any> = mutableMapOf())

SearchClient

class SearchClient(val restClient: RestClient = KtorRestClient(), val json: Json = DEFAULT_JSON)

Search client that you can use to talk to Elasticsearch or Opensearch.

SearchEngineInformation

@Serializable

data class SearchEngineInformation(val name: String, val clusterName: String, val clusterUUID: String, val version: SearchEngineVersion)

SearchEngineVersion

@Serializable

data class SearchEngineVersion(val distribution: String?, val number: String, val buildFlavor: String?, val buildHash: String, val buildDate: String, val buildSnapshot: Boolean, val luceneVersion: String, val minimumWireCompatibilityVersion: String, val minimumIndexCompatibilityVersion: String)

SearchOperator

enum SearchOperator : Enum<SearchOperator>

SearchResponse

@Serializable

data class SearchResponse(val took: Long?, val shards: Shards?, val timedOut: Boolean?, val hits: SearchResponse.Hits?, val aggregations: Aggregations?, val scrollId: String?, val pitId: String?, val pointInTimeId: String?, val suggest: Map<String, List<SearchResponse.Suggest>>?)

SearchType

enum SearchType : Enum<SearchType>

Shards

@Serializable

data class Shards(val total: Int, val successful: Int, val failed: Int, val skipped: Int? = null)

SnapshotRepository

class SnapshotRepository : JsonDsl

SniffingNodeSelector

class SniffingNodeSelector(initialNodes: Node, maxNodeAge: Duration = 1.minutes, https: Boolean = false, user: String? = null, password: String? = null) : NodeSelector

If you are running against a cluster without a node balancer you can use this node selector to make the client sniff nodes from the cluster.

SourceInformation

interface SourceInformation

SuggestMode

enum SuggestMode : Enum<SuggestMode>

SumAggregationResult

@Serializable

data class SumAggregationResult(val value: Double)

TaskId

data class TaskId(val value: String)

TaskResponse

@Serializable

data class TaskResponse(val task: String)

TermsAggregationResult

@Serializable

data class TermsAggregationResult(val docCountErrorUpperBound: Long, val sumOtherDocCount: Long, val buckets: List<JsonObject>) : BucketAggregationResult<TermsBucket>

TermsBucket

@Serializable

data class TermsBucket(val key: String, val docCount: Long, val keyAsString: String?)

TopHitsAggregationResult

@Serializable

data class TopHitsAggregationResult(val hits: SearchResponse.Hits)

VariantInfo

data class VariantInfo(val variant: SearchEngineVariant, val versionString: String)

Search engine variant meta data.

VersionType

enum VersionType : Enum<VersionType>

Properties

ids

val SearchResponse.ids: List<String>

keyAsInstant

val DateHistogramBucket.keyAsInstant: Instant

namedBuckets

val FiltersAggregationResult.namedBuckets: List<FilterBucket>

parsedBuckets

val DateHistogramAggregationResult.parsedBuckets: <Error class: unknown class>

val DateRangesAggregationResult.parsedBuckets: <Error class: unknown class>

val GeoTileGridResult.parsedBuckets: <Error class: unknown class>

val RangesAggregationResult.parsedBuckets: <Error class: unknown class>

val TermsAggregationResult.parsedBuckets: <Error class: unknown class>

searchHits

val SearchResponse.searchHits: List<SearchResponse.Hit>

total

val SearchResponse.total: Long

usable

val ClusterStatus.usable: Boolean

Functions

analyze

suspend fun SearchClient.analyze(target: String? = null, block: AnalyzeRequest.() -> Unit): AnalyzeResponse

asResult

fun RestResponse.asResult(): Result<RestResponse.Status2XX>

awaitTaskCompleted

suspend fun SearchClient.awaitTaskCompleted(id: TaskId, timeout: Duration, interval: Duration = 5.seconds): JsonObject?

suspend fun SearchClient.awaitTaskCompleted(id: String, timeout: Duration, interval: Duration = 5.seconds): JsonObject?

Polls the given task id to check if the task is completed. Waits for timeout and polls every interval to check if the task is completed.

bucket

fun FiltersAggregationResult.bucket(name: String, json: Json): FilterBucket?

bucketScriptResult

fun Aggregations?.bucketScriptResult(name: Enum<*>, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

fun Aggregations?.bucketScriptResult(name: String, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

bulk

suspend fun SearchClient.bulk(payload: String, target: String? = null, pipeline: String? = null, refresh: Refresh? = null, routing: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, requireAlias: Boolean? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, extraParameters: Map<String, String>? = null): <Error class: unknown class>

Send a single bulk request. Consider using the variant that creates a BulkSession.

suspend fun SearchClient.bulk(bulkSize: Int = 100, target: String? = null, pipeline: String? = null, refresh: Refresh? = Refresh.WaitFor, routing: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, requireAlias: Boolean? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, failOnFirstError: Boolean = false, callBack: BulkItemCallBack? = null, closeOnRequestError: Boolean = true, extraParameters: Map<String, String>? = null, block: suspend BulkSession.() -> Unit)

Creates a bulk session that allows you to index, create, or delete items via the convenient kotlin DSL.

bulkSession

fun SearchClient.bulkSession(bulkSize: Int = 100, target: String? = null, pipeline: String? = null, refresh: Refresh? = null, routing: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, requireAlias: Boolean? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, failOnFirstError: Boolean = false, callBack: BulkItemCallBack? = null, closeOnRequestError: Boolean = true, extraParameters: Map<String, String>? = null): BulkSession

cancelTask

suspend fun SearchClient.cancelTask(id: String, waitForCompletion: Boolean = false, timeout: Duration = 1.minutes): JsonObject

cardinalityResult

fun Aggregations?.cardinalityResult(name: Enum<*>, json: Json = DEFAULT_JSON): LongValueAggregationResult

fun Aggregations?.cardinalityResult(name: String, json: Json = DEFAULT_JSON): LongValueAggregationResult

clusterHealth

suspend fun SearchClient.clusterHealth(extraParameters: Map<String, String>? = null): ClusterHealthResponse

count

suspend fun SearchClient.count(target: String? = null, query: ESQuery, allowNoIndices: Boolean? = null, expandWildcards: ExpandWildCards? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, minScore: Double? = null, preference: String? = null, routing: String? = null, terminateAfter: Int? = null): CountResponse

Variant of the _count api that allows you to pass in an ESQuery object. It will be set as the query on the json body that is sent to _count.

suspend fun SearchClient.count(target: String? = null, allowNoIndices: Boolean? = null, expandWildcards: ExpandWildCards? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, minScore: Double? = null, preference: String? = null, routing: String? = null, terminateAfter: Int? = null, block: SearchDSL.() -> Unit): CountResponse

Variant of the _count api that takes a search dsl block so you can set the query. Note, not all parts of the search dsl are supported by _count. E.g. adding sorting would be an error.

suspend fun SearchClient.count(target: String? = null, rawJson: String? = null, allowNoIndices: Boolean? = null, expandWildcards: ExpandWildCards? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, minScore: Double? = null, preference: String? = null, routing: String? = null, terminateAfter: Int? = null): CountResponse

Variant of the _count api that takes an optional rawBody. Leaving the body empty means doing a match_all search.

counts

fun List<TermsBucket>.counts(): Map<String, Long>

create

inline suspend fun <T> BulkSession.create(doc: T, index: String? = null, id: String? = null, requireAlias: Boolean? = null, routing: String? = null)

createDataStream

suspend fun SearchClient.createDataStream(name: String): JsonObject

createIndex

suspend fun SearchClient.createIndex(name: String, mapping: IndexSettingsAndMappingsDSL, waitForActiveShards: Int? = null, masterTimeOut: Duration? = null, timeout: Duration? = null, extraParameters: Map<String, String>? = null): IndexCreateResponse

suspend fun SearchClient.createIndex(name: String, waitForActiveShards: Int? = null, masterTimeOut: Duration? = null, timeout: Duration? = null, extraParameters: Map<String, String>? = null, block: IndexSettingsAndMappingsDSL.() -> Unit? = null): IndexCreateResponse

suspend fun SearchClient.createIndex(name: String, mappingAndSettings: String, waitForActiveShards: Int? = null, masterTimeOut: Duration? = null, timeout: Duration? = null, extraParameters: Map<String, String>? = null): IndexCreateResponse

createIndexTemplate

suspend fun SearchClient.createIndexTemplate(templateId: String, block: IndexTemplate.() -> Unit): JsonObject

createPointInTime

suspend fun SearchClient.createPointInTime(name: String, keepAlive: Duration): String

Create a point in time for use with e.g. search_after.

dateHistogramResult

fun Aggregations?.dateHistogramResult(name: Enum<*>, json: Json = DEFAULT_JSON): DateHistogramAggregationResult

fun Aggregations?.dateHistogramResult(name: String, json: Json = DEFAULT_JSON): DateHistogramAggregationResult

dateRangeCounts

fun List<DateRangesBucket>.dateRangeCounts(): Map<String, Long>

dateRangesResult

fun Aggregations?.dateRangesResult(name: Enum<*>, json: Json = DEFAULT_JSON): DateRangesAggregationResult

fun Aggregations?.dateRangesResult(name: String, json: Json = DEFAULT_JSON): DateRangesAggregationResult

defaultInit

fun HttpClientConfig<*>.defaultInit(logging: Boolean, user: String?, password: String?, elasticApiKey: String?)

defaultKtorHttpClient

expect fun defaultKtorHttpClient(logging: Boolean = false, user: String? = null, password: String? = null, elasticApiKey: String? = null, block: HttpClientConfig<*>.() -> Unit): HttpClient

actual fun defaultKtorHttpClient(logging: Boolean, user: String?, password: String?, elasticApiKey: String?, block: HttpClientConfig<*>.() -> Unit): HttpClient

delete

suspend fun RestClient.delete(block: SearchAPIRequest.() -> Unit): Result<RestResponse.Status2XX>

deleteByQuery

suspend fun SearchClient.deleteByQuery(target: String?, dsl: SearchDSL, allowNoIndices: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, conflicts: String? = null, defaultOperator: SearchOperator? = null, df: String? = null, expandWildcards: ExpandWildCards? = null, ignoreUnavailable: Boolean? = null, lenient: Boolean? = null, maxDocs: Int? = null, preference: String? = null, q: String? = null, refresh: Boolean? = null, requestCache: Boolean? = null, requestsPerSecond: Int? = null, routing: String? = null, scroll: String? = null, scrollSize: Int? = null, searchType: SearchType? = null, searchTimeout: String? = null, slices: Int? = null, sort: String? = null, stats: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, version: Boolean? = null, waitForExtraShards: String? = null, extraParameters: Map<String, String>? = null): DeleteByQueryResponse

suspend fun SearchClient.deleteByQuery(target: String?, allowNoIndices: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, conflicts: String? = null, defaultOperator: SearchOperator? = null, df: String? = null, expandWildcards: ExpandWildCards? = null, ignoreUnavailable: Boolean? = null, lenient: Boolean? = null, maxDocs: Int? = null, preference: String? = null, q: String? = null, refresh: Boolean? = null, requestCache: Boolean? = null, requestsPerSecond: Int? = null, routing: String? = null, scroll: String? = null, scrollSize: Int? = null, searchType: SearchType? = null, searchTimeout: String? = null, slices: Int? = null, sort: String? = null, stats: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, version: Boolean? = null, waitForExtraShards: String? = null, extraParameters: Map<String, String>? = null, block: SearchDSL.() -> Unit): DeleteByQueryResponse

suspend fun SearchClient.deleteByQuery(target: String?, rawJson: String?, allowNoIndices: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, conflicts: String? = null, defaultOperator: SearchOperator? = null, df: String? = null, expandWildcards: ExpandWildCards? = null, ignoreUnavailable: Boolean? = null, lenient: Boolean? = null, maxDocs: Int? = null, preference: String? = null, q: String? = null, refresh: Boolean? = null, requestCache: Boolean? = null, requestsPerSecond: Int? = null, routing: String? = null, scroll: String? = null, scrollSize: Int? = null, searchType: SearchType? = null, searchTimeout: String? = null, slices: Int? = null, sort: String? = null, stats: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, version: Boolean? = null, waitForExtraShards: String? = null, extraParameters: Map<String, String>? = null): DeleteByQueryResponse

deleteComponentTemplate

suspend fun SearchClient.deleteComponentTemplate(templateId: String): JsonObject

deleteDataStream

suspend fun SearchClient.deleteDataStream(name: String): JsonObject

deleteDocument

suspend fun SearchClient.deleteDocument(target: String, id: String, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, refresh: Refresh? = null, routing: String? = null, timeout: Duration? = null, version: Long? = null, versionType: VersionType? = null, waitForActiveShards: String? = null, extraParameters: Map<String, String>? = null): DocumentIndexResponse

deleteIlmPolicy

suspend fun SearchClient.deleteIlmPolicy(policyId: String): JsonObject

deleteIndex

suspend fun SearchClient.deleteIndex(target: String, masterTimeOut: Duration? = null, timeout: Duration? = null, ignoreUnavailable: Boolean? = null, extraParameters: Map<String, String>? = null): JsonObject

deleteIndexTemplate

suspend fun SearchClient.deleteIndexTemplate(templateId: String): JsonObject

deletePointInTime

suspend fun SearchClient.deletePointInTime(id: String): JsonObject

deleteScroll

suspend fun SearchClient.deleteScroll(scrollId: String?): JsonObject

Delete a scroll by id.

deleteSnapshot

suspend fun SearchClient.deleteSnapshot(repositoryName: String, snapshotName: String, waitForCompletion: Boolean = false, timeout: Duration = 1.minutes): JsonObject

deleteSnapshotRepository

suspend fun SearchClient.deleteSnapshotRepository(repositoryName: String): JsonObject

document

inline fun <T> SourceInformation.document(json: Json = DEFAULT_JSON): T

documents

inline fun <T> MGetResponse.documents(json: Json = DEFAULT_JSON): List<T>

exists

suspend fun SearchClient.exists(name: String): Boolean

extendedStatsBucketResult

fun Aggregations?.extendedStatsBucketResult(name: Enum<*>, json: Json = DEFAULT_JSON): ExtendedStatsBucketResult

fun Aggregations?.extendedStatsBucketResult(name: String, json: Json = DEFAULT_JSON): ExtendedStatsBucketResult

filterResult

fun Aggregations?.filterResult(name: String): FilterBucket?

filtersResult

fun Aggregations?.filtersResult(name: Enum<*>, json: Json = DEFAULT_JSON): FiltersAggregationResult

fun Aggregations?.filtersResult(name: String, json: Json = DEFAULT_JSON): FiltersAggregationResult

formatTimestamp

fun formatTimestamp(): String

geoCentroid

fun Aggregations?.geoCentroid(name: Enum<*>): GeoCentroidResult

fun Aggregations?.geoCentroid(name: String): GeoCentroidResult

geoTileGridResult

fun Aggregations?.geoTileGridResult(name: Enum<*>, json: Json = DEFAULT_JSON): GeoTileGridResult

fun Aggregations?.geoTileGridResult(name: String, json: Json = DEFAULT_JSON): GeoTileGridResult

get

suspend fun RestClient.get(block: SearchAPIRequest.() -> Unit): Result<RestResponse.Status2XX>

getAggResult

inline fun <T> Aggregations?.getAggResult(name: Enum<*>, json: Json = DEFAULT_JSON): T

inline fun <T> Aggregations?.getAggResult(name: String, json: Json = DEFAULT_JSON): T

getAliases

suspend fun SearchClient.getAliases(target: String? = null): Map<String, AliasResponse>

Returns the aliases for a target.

getAliasNamesForIndex

suspend fun SearchClient.getAliasNamesForIndex(index: String): Set<String>

Returns the set of alias names for an index or an empty set.

getDocument

suspend fun SearchClient.getDocument(target: String, id: String, preference: String? = null, realtime: Boolean? = null, refresh: Refresh? = null, routing: String? = null, storedFields: String? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, version: Long? = null, versionType: VersionType? = null, extraParameters: Map<String, String>? = null): GetDocumentResponse

getIlmPolicy

suspend fun SearchClient.getIlmPolicy(policyId: String): JsonObject

getIndex

suspend fun SearchClient.getIndex(name: String): JsonObject

getIndexesForAlias

suspend fun SearchClient.getIndexesForAlias(alias: String): Set<String>

Returns the set of indices that have the alias. If you call this on an index, the returned set will just contain the index.

getIndexMappings

suspend fun SearchClient.getIndexMappings(name: String): JsonObject

getSnapshotRepository

suspend fun SearchClient.getSnapshotRepository(repositoryName: String?): JsonObject

getTask

suspend fun SearchClient.getTask(id: String?, waitForCompletion: Boolean = false, timeout: Duration = 1.minutes): JsonObject

head

suspend fun RestClient.head(block: SearchAPIRequest.() -> Unit): RestResponse

index

inline suspend fun <T> BulkSession.index(doc: T, index: String? = null, id: String? = null, requireAlias: Boolean? = null, routing: String? = null)

indexDocument

suspend fun SearchClient.indexDocument(target: String, serializedJson: String, id: String? = null, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, opType: OperationType? = null, pipeline: String? = null, refresh: Refresh? = null, routing: String? = null, timeout: Duration? = null, version: Long? = null, versionType: VersionType? = null, waitForActiveShards: String? = null, requireAlias: Boolean? = null, extraParameters: Map<String, String>? = null): DocumentIndexResponse

inline suspend fun <T> SearchClient.indexDocument(target: String, document: T, id: String? = null, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, opType: OperationType? = null, pipeline: String? = null, refresh: Refresh? = null, routing: String? = null, timeout: Duration? = null, version: Long? = null, versionType: VersionType? = null, waitForActiveShards: String? = null, requireAlias: Boolean? = null, extraParameters: Map<String, String>? = null, json: Json = DEFAULT_JSON): DocumentIndexResponse

ktorClientWithCIOEngine

fun ktorClientWithCIOEngine(logging: Boolean, user: String?, password: String?, elasticApiKey: String?, block: HttpClientConfig<*>.() -> Unit): HttpClient

ktorClientWithJavaEngine

fun ktorClientWithJavaEngine(logging: Boolean, user: String?, password: String?, elasticApiKey: String?, block: HttpClientConfig<*>.() -> Unit): HttpClient

listSnapshots

suspend fun SearchClient.listSnapshots(repositoryName: String, pattern: String = "_all"): JsonObject

maxResult

fun Aggregations?.maxResult(name: Enum<*>, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

fun Aggregations?.maxResult(name: String, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

mGet

suspend fun SearchClient.mGet(index: String? = null, preference: String? = null, realtime: Boolean? = null, refresh: Refresh? = null, routing: String? = null, storedFields: String? = null, source: String? = null, block: MGetRequest.() -> Unit): MGetResponse

minResult

fun Aggregations?.minResult(name: Enum<*>, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

fun Aggregations?.minResult(name: String, json: Json = DEFAULT_JSON): DoubleValueAggregationResult

msearch

suspend fun SearchClient.msearch(target: String?, allowNoIndices: Boolean? = null, cssMinimizeRoundtrips: Boolean? = null, expandWildcards: ExpandWildCards? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, maxConcurrentSearches: Int? = null, maxConcurrentShardRequests: Int? = null, preFilterShardSize: Int? = null, routing: String? = null, searchType: SearchType? = null, typedKeys: Boolean? = null, block: MsearchRequest.() -> Unit): MultiSearchResponse

suspend fun SearchClient.msearch(target: String? = null, body: String?, allowNoIndices: Boolean? = null, cssMinimizeRoundtrips: Boolean? = null, expandWildcards: ExpandWildCards? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, maxConcurrentSearches: Int? = null, maxConcurrentShardRequests: Int? = null, preFilterShardSize: Int? = null, routing: String? = null, searchType: SearchType? = null, typedKeys: Boolean? = null): MultiSearchResponse

msearchHeader

fun msearchHeader(block: MsearchHeader.() -> Unit): MsearchHeader

names

fun MatchedQueries?.names(json: Json = DEFAULT_JSON): List<String>

If include_named_queries_score parameter is not true only ES returns only query names for each Hit. If include_named_queries_score is true please use the scoreByName function.

parse

inline fun <T> JsonObject.parse(json: Json = DEFAULT_JSON): T

fun <T> Result<RestResponse>.parse(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): T

fun <T> JsonObject.parse(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): T

fun <T> JsonObject.parse(json: Json = DEFAULT_JSON, deserializationStrategy: DeserializationStrategy<T>): T

parseHit

inline fun <T> SearchResponse.Hit.parseHit(json: Json = DEFAULT_JSON): T

fun <T> SearchResponse.Hit.parseHit(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): T

parseHits

inline fun <T> Flow<SearchResponse.Hit>.parseHits(): Flow<T>

fun <T : Any> Flow<SearchResponse.Hit>.parseHits(deserializationStrategy: ModelSerializationStrategy<T>): Flow<T>

fun <T> Flow<SearchResponse.Hit>.parseHits(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): Flow<T>

fun <T : Any> SearchResponse.parseHits(deserializationStrategy: ModelSerializationStrategy<T>): List<T>

Version of parseHits that reuses the ModelSerializationStrategy.

inline fun <T> SearchResponse.parseHits(json: Json = DEFAULT_JSON): List<T>

Quick way to get the document hits from a SearchResponse. You can override the default json if you need to.

fun <T> SearchResponse.parseHits(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): List<T>

Non reified version of parseHits that takes a deserializationStrategy.

parseJsonObject

fun Result<RestResponse>.parseJsonObject(): JsonObject

post

suspend fun RestClient.post(block: SearchAPIRequest.() -> Unit): Result<RestResponse.Status2XX>

put

suspend fun RestClient.put(block: SearchAPIRequest.() -> Unit): Result<RestResponse.Status2XX>

rangeCounts

fun List<RangesBucket>.rangeCounts(): Map<String, Long>

rangesResult

fun Aggregations?.rangesResult(name: Enum<*>, json: Json = DEFAULT_JSON): RangesAggregationResult

fun Aggregations?.rangesResult(name: String, json: Json = DEFAULT_JSON): RangesAggregationResult

registerSnapshotRepository

suspend fun SearchClient.registerSnapshotRepository(repositoryName: String, repository: SnapshotRepository): JsonObject

suspend fun SearchClient.registerSnapshotRepository(repositoryName: String, block: SnapshotRepository.() -> Unit)

reindex

suspend fun SearchClient.reindex(refresh: Boolean? = null, timeout: Duration? = null, waitForActiveShards: String? = null, requestsPerSecond: Int? = null, requireAlias: Boolean? = null, scroll: Duration? = null, slices: Int? = null, maxDocs: Int? = null, block: ReindexDSL.() -> Unit): ReindexResponse

Reindex and waits for completion. Returns a reindex response indicating what was reindexed.

reindexAndAwaitTask

suspend fun SearchClient.reindexAndAwaitTask(refresh: Boolean? = null, timeout: Duration = 20.minutes, waitForActiveShards: String? = null, requestsPerSecond: Int? = null, requireAlias: Boolean? = null, scroll: Duration? = null, slices: Int? = null, maxDocs: Int? = null, pollInterval: Duration = 5.seconds, block: ReindexDSL.() -> Unit): ReindexResponse?

Reindexes using a background task in ES and polls for that task to complete every pollInterval for a maximum of timeout. Note: the same timeout is passed on to the reindex task

reindexAsync

suspend fun SearchClient.reindexAsync(refresh: Boolean? = null, timeout: Duration? = null, waitForActiveShards: String? = null, requestsPerSecond: Int? = null, requireAlias: Boolean? = null, scroll: Duration? = null, slices: Int? = null, maxDocs: Int? = null, block: ReindexDSL.() -> Unit): TaskId

Reindexes using a background task in ES. Returns a TaskId response with an id that you can use with the task api.

restoreSnapshot

suspend fun SearchClient.restoreSnapshot(repositoryName: String, snapshotName: String, waitForCompletion: Boolean = false, timeout: Duration = 1.minutes): JsonObject

root

suspend fun SearchClient.root(): SearchEngineInformation

Http GET to /

rrf

fun MultiSearchResponse.rrf(k: Int = 60): List<Pair<String, Double>>

scoreByName

fun MatchedQueries?.scoreByName(json: Json = DEFAULT_JSON): Map<String, Double>

The request parameter named include_named_queries_score controls whether scores associated with the matched queries are returned or not. When set, the response includes a matched_queries map that contains the name of the query that matched as a key and its associated score as the value.

scroll

suspend fun SearchClient.scroll(response: SearchResponse): Flow<SearchResponse.Hit>

Scroll through search results for a scrolling search.

suspend fun SearchClient.scroll(scrollId: String, scroll: Duration = 60.seconds): SearchResponse

suspend fun SearchClient.search(target: String?, allowNoIndices: Boolean? = null, allowPartialSearchResults: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, batchedReduceSize: Int? = null, ccsMinimizeRoundtrips: Boolean? = null, defaultOperator: SearchOperator? = null, df: String? = null, docvalueFields: String? = null, expandWildcards: ExpandWildCards? = null, explain: Boolean? = null, from: Int? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, include_named_queries_score: Boolean? = null, lenient: Boolean? = null, maxConcurrentShardRequests: Int? = null, preFilterShardSize: Int? = null, preference: String? = null, q: String? = null, requestCache: Boolean? = null, restTotalHitsAsInt: Boolean? = null, routing: String? = null, scroll: String? = null, searchType: SearchType? = null, seqNoPrimaryTerm: Boolean? = null, size: Int? = null, sort: String? = null, _source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, stats: String? = null, storedFields: String? = null, suggestField: String? = null, suggestMode: SuggestMode? = null, suggestSize: Int? = null, suggestText: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, trackScores: Boolean? = null, trackTotalHits: Boolean? = null, typedKeys: Boolean? = null, version: Boolean? = null, extraParameters: Map<String, String>? = null, block: SearchDSL.() -> Unit? = null): SearchResponse

suspend fun SearchClient.search(target: String?, dsl: SearchDSL, allowNoIndices: Boolean? = null, allowPartialSearchResults: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, batchedReduceSize: Int? = null, ccsMinimizeRoundtrips: Boolean? = null, defaultOperator: SearchOperator? = null, df: String? = null, docvalueFields: String? = null, expandWildcards: ExpandWildCards? = null, explain: Boolean? = null, from: Int? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, include_named_queries_score: Boolean? = null, lenient: Boolean? = null, maxConcurrentShardRequests: Int? = null, preFilterShardSize: Int? = null, preference: String? = null, q: String? = null, requestCache: Boolean? = null, restTotalHitsAsInt: Boolean? = null, routing: String? = null, scroll: String? = null, searchType: SearchType? = null, seqNoPrimaryTerm: Boolean? = null, size: Int? = null, sort: String? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, stats: String? = null, storedFields: String? = null, suggestField: String? = null, suggestMode: SuggestMode? = null, suggestSize: Int? = null, suggestText: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, trackScores: Boolean? = null, trackTotalHits: Boolean? = null, typedKeys: Boolean? = null, version: Boolean? = null, extraParameters: Map<String, String>? = null, retries: Int = 3, retryDelay: Duration = 2.seconds): SearchResponse

suspend fun SearchClient.search(target: String?, rawJson: String?, allowNoIndices: Boolean? = null, allowPartialSearchResults: Boolean? = null, analyzer: String? = null, analyzeWildcard: Boolean? = null, batchedReduceSize: Int? = null, ccsMinimizeRoundtrips: Boolean? = null, defaultOperator: SearchOperator? = null, df: String? = null, docValueFields: String? = null, expandWildcards: ExpandWildCards? = null, explain: Boolean? = null, from: Int? = null, ignoreThrottled: Boolean? = null, ignoreUnavailable: Boolean? = null, include_named_queries_score: Boolean? = null, lenient: Boolean? = null, maxConcurrentShardRequests: Int? = null, preFilterShardSize: Int? = null, preference: String? = null, q: String? = null, requestCache: Boolean? = null, restTotalHitsAsInt: Boolean? = null, routing: String? = null, scroll: String? = null, searchType: SearchType? = null, seqNoPrimaryTerm: Boolean? = null, size: Int? = null, sort: String? = null, source: String? = null, sourceExcludes: String? = null, sourceIncludes: String? = null, stats: String? = null, storedFields: String? = null, suggestField: String? = null, suggestMode: SuggestMode? = null, suggestSize: Int? = null, suggestText: String? = null, terminateAfter: Int? = null, timeout: Duration? = null, trackScores: Boolean? = null, trackTotalHits: Boolean? = null, typedKeys: Boolean? = null, version: Boolean? = null, extraParameters: Map<String, String>? = null, retries: Int = 3, retryDelay: Duration = 2.seconds): SearchResponse

searchAfter

suspend fun SearchClient.searchAfter(target: String, keepAlive: Duration = 1.minutes, optInToCustomSort: Boolean = false, block: SearchDSL.() -> Unit? = null): Pair<SearchResponse, Flow<SearchResponse.Hit>>

suspend fun SearchClient.searchAfter(target: String, keepAlive: Duration, query: SearchDSL, optInToCustomSort: Boolean = false, retries: Int = 3, retryDelay: Duration = 2.seconds): Pair<SearchResponse, Flow<SearchResponse.Hit>>

Perform a deep paging search using point in time and search after.

setIlmPolicy

suspend fun SearchClient.setIlmPolicy(policyId: String, block: IMLPhases.() -> Unit): AcknowledgedResponse

simpleIndexProvider

expect fun simpleIndexProvider(initialIndex: Int = 0): IndexProvider

actual fun simpleIndexProvider(initialIndex: Int): IndexProvider

snakeCase

fun Enum<*>.snakeCase(): String

sumAggregationResult

fun Aggregations?.sumAggregationResult(name: Enum<*>, json: Json = DEFAULT_JSON): TopHitsAggregationResult

fun Aggregations?.sumAggregationResult(name: String, json: Json = DEFAULT_JSON): SumAggregationResult

takeSnapshot

suspend fun SearchClient.takeSnapshot(repositoryName: String, snapshotName: String = formatTimestamp(), waitForCompletion: Boolean = false, timeout: Duration = 1.minutes): JsonObject

termsResult

fun Aggregations?.termsResult(name: Enum<*>, json: Json = DEFAULT_JSON): TermsAggregationResult

fun Aggregations?.termsResult(name: String, json: Json = DEFAULT_JSON): TermsAggregationResult

threadId

expect fun threadId(): String?

On JVM this will return the current thread name, on kotlin-js this will return null

actual fun threadId(): String?

On JVM this will return the current thread name, otherwise this will return null and pick a random node

actual fun threadId(): String?

On JVM this will return the current thread name, otherwise this will return null and pick a random node

actual fun threadId(): String?

On JVM this will return the current thread name, otherwise this will return null and pick a random node

actual fun threadId(): String?

On JVM this will return the current thread name, otherwise this will return null and pick a random node

actual fun threadId(): String?

On JVM this will return the current thread name, on kotlin-js this will return null

toElasticsearchTimeUnit

fun Duration?.toElasticsearchTimeUnit(): String?

topHitResult

fun Aggregations?.topHitResult(name: Enum<*>, json: Json = DEFAULT_JSON): TopHitsAggregationResult

fun Aggregations?.topHitResult(name: String, json: Json = DEFAULT_JSON): TopHitsAggregationResult

update

inline suspend fun <T> BulkSession.update(doc: T, id: String, index: String? = null, requireAlias: Boolean? = null, docAsUpsert: Boolean? = null)

inline suspend fun <T> BulkSession.update(script: Script, id: String, upsert: T, index: String? = null, requireAlias: Boolean? = null)

updateAliases

suspend fun SearchClient.updateAliases(block: AliasUpdateRequest.() -> Unit): AcknowledgedResponse

Atomically process alias updates with a DSL.

updateComponentTemplate

suspend fun SearchClient.updateComponentTemplate(templateId: String, block: IndexSettingsAndMappingsDSL.() -> Unit): JsonObject

updateDocument

suspend fun SearchClient.updateDocument(target: String, id: String, script: Script, upsertJson: String? = null, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, requireAlias: Boolean? = null, retryOnConflict: Int? = null, refresh: Refresh? = null, routing: String? = null, source: String? = null, sourceIncludes: String? = null, sourceExcludes: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, extraParameters: Map<String, String>? = null): DocumentUpdateResponse

suspend fun SearchClient.updateDocument(target: String, id: String, docJson: String, detectNoop: Boolean? = null, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, requireAlias: Boolean? = null, retryOnConflict: Int? = null, refresh: Refresh? = null, routing: String? = null, source: String? = null, sourceIncludes: String? = null, sourceExcludes: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, extraParameters: Map<String, String>? = null): DocumentUpdateResponse

inline suspend fun <T> SearchClient.updateDocument(target: String, id: String, doc: T, json: Json = DEFAULT_JSON, detectNoop: Boolean? = null, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, requireAlias: Boolean? = null, retryOnConflict: Int? = null, refresh: Refresh? = null, routing: String? = null, source: String? = null, sourceIncludes: String? = null, sourceExcludes: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, extraParameters: Map<String, String>? = null): DocumentUpdateResponse

inline suspend fun <T> SearchClient.updateDocument(target: String, id: String, script: Script, upsertJson: T, json: Json = DEFAULT_JSON, ifSeqNo: Long? = null, ifPrimaryTerm: Long? = null, requireAlias: Boolean? = null, retryOnConflict: Int? = null, refresh: Refresh? = null, routing: String? = null, source: String? = null, sourceIncludes: String? = null, sourceExcludes: String? = null, timeout: Duration? = null, waitForActiveShards: String? = null, extraParameters: Map<String, String>? = null): DocumentUpdateResponse

verifySnapshotRepository

suspend fun SearchClient.verifySnapshotRepository(repositoryName: String): JsonObject