package elastic4s
- Alphabetic
- Public
- All
Type Members
- case class CommonRequestOptions(timeout: Duration, masterNodeTimeout: Duration, headers: Map[String, String] = Map.empty) extends Product with Serializable
- trait ElasticApi extends AliasesApi with AggregationApi with AnalyzerApi with BulkApi with CatsApi with CreateIndexApi with ClearRolesCacheApi with ClusterApi with CollapseApi with CountApi with CreateRoleApi with CreateUserApi with DeleteApi with DeleteIndexApi with DeleteRoleApi with DeleteUserApi with ExistsApi with ExplainApi with ForceMergeApi with GetApi with HighlightApi with IndexApi with IndexAdminApi with AnalyzeApi with IndexRecoveryApi with IndexTemplateApi with IngestApi with LocksApi with MappingApi with NodesApi with NormalizerApi with QueryApi with PipelineAggregationApi with ReindexApi with ReloadSearchAnalyzersApi with RoleApi with ScriptApi with ScoreApi with ScrollApi with SearchApi with SearchTemplateApi with SettingsApi with SnapshotApi with SortApi with StoredScriptApi with SuggestionApi with SynonymsApi with TaskApi with TermVectorApi with TermsEnumApi with TokenizerApi with TokenFilterApi with TypesApi with UpdateApi with UserAdminApi with UserApi with ValidateApi with KnnApi with PitApi
-
case class
ElasticClient(client: HttpClient) extends AutoCloseable with Product with Serializable
An ElasticClient is used to execute HTTP requests against an ElasticSearch cluster.
An ElasticClient is used to execute HTTP requests against an ElasticSearch cluster. This class delegates the actual HTTP calls to an instance of HttpClient.
Any third party HTTP client library can be made to work with elastic4s by creating an instance of the HttpClient typeclass wrapping the underlying client library and then creating the ElasticClient with it.
- client
the HTTP client library to use
- trait ElasticDsl extends ElasticDslWithoutSearch with SearchHandlers
- trait ElasticDslWithoutSearch extends ElasticApi with BulkHandlers with CatHandlers with CountHandlers with ClusterHandlers with DeleteHandlers with ExistsHandlers with ExplainHandlers with GetHandlers with IndexHandlers with IndexAdminHandlers with IndexAliasHandlers with IndexStatsHandlers with IndexTemplateHandlers with IngestHandlers with LocksHandlers with MappingHandlers with NodesHandlers with ReindexHandlers with ReloadSearchAnalyzersHandlers with RoleAdminHandlers with RoleHandlers with RolloverHandlers with SearchTemplateHandlers with SearchScrollHandlers with SettingsHandlers with SnapshotHandlers with StoredScriptHandlers with SynonymsHandlers with UpdateHandlers with TaskHandlers with TermVectorHandlers with TermsEnumHandlers with UserAdminHandlers with UserHandlers with ValidateHandlers with PitHandlers
-
case class
ElasticNodeEndpoint(protocol: String, host: String, port: Int, prefix: Option[String]) extends Product with Serializable
Holds all of the variables needed to describe the HTTP endpoint of an elasticsearch node.
Holds all of the variables needed to describe the HTTP endpoint of an elasticsearch node.
- protocol
http or https
- host
the hostname of the node
- port
the port of the server process
- prefix
an optional prefix that will be prepended to all requests
-
case class
ElasticProperties(endpoints: Seq[ElasticNodeEndpoint], options: Map[String, String] = Map.empty) extends Product with Serializable
Contains the endpoints of the nodes to connect to, as well as connection properties.
- trait Executor[F[_]] extends AnyRef
- trait Functor[F[_]] extends AnyRef
-
trait
HttpClient extends AutoCloseable
A typeclass that an underlying http client can implement, so that it can be used by the ElasticClient implementation by elastic4s.
A typeclass that an underlying http client can implement, so that it can be used by the ElasticClient implementation by elastic4s.
In other words, this is a wrapper trait so that HTTP libraries such as Apache HTTP commons, Akka HTTP client, STTP or whatever can be used with elasticsearch. The wrapped client can then be passed into the ElasticClient.
- case class RequestFailure(status: Int, body: Option[String], headers: Map[String, String], error: ElasticError) extends Response[Nothing] with Product with Serializable
- case class RequestSuccess[U](status: Int, body: Option[String], headers: Map[String, String], result: U) extends Response[U] with Product with Serializable
- sealed trait Response[+U] extends AnyRef
-
case class
ElasticsearchClientUri(uri: String, hosts: List[(String, Int)], options: Map[String, String] = Map.empty) extends Product with Serializable
Uri used to connect to an Elasticsearch cluster.
Uri used to connect to an Elasticsearch cluster. The general format is
http(s)://host:port),host:port)?querystring
Multiple host:port combinations can be specified, seperated by commas. Options can be specified using standard uri query string syntax, eg cluster.name=superman
To use HTTPS when using the HTTP client, add ssl=true to the query parameters.
- Annotations
- @deprecated
- Deprecated
(Since version 6.3.3) Use ElasticNodeEndpoint
Value Members
- object CommonRequestOptions extends Serializable
- object ElasticApi extends ElasticApi
- object ElasticDsl extends ElasticDsl
- object ElasticProperties extends Serializable
- object Executor
- object Functor
Deprecated Value Members
-
object
ElasticsearchClientUri extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 6.3.3) Use ElasticNodeEndpoint