PLUGINSPLUGIN-ELASTICSEARCHTASKSIO.KESTRA.PLUGIN.ELASTICSEARCH.SEARCH

Search

Table of Contents

Contribute

Search

yaml

type: "io.kestra.plugin.elasticsearch.Search"

Send a search request

Get all documents from a search request and store it as outputs

Examples

yaml

id: "search"
type: "io.kestra.plugin.elasticsearch.Search"
connection:
  hosts: 
   - "http://localhost:9200"
indexes:
 - "my_index"
request:
  query: 
    term:
      name:
        value: 'john'

Properties

`connection`

Type: ElasticsearchConnection
Dynamic: ❓
Required: ✔️

The connection properties.

`contentType`

Type: string
Dynamic: ❌
Required: ❌
Possible Values:
- JSON
- SMILE
- YAML
- CBOR

The content type of value

`indexes`

Type: array
SubType: string
Dynamic: ✔️
Required: ❌

The elasticsearch indices

Default to all indices

`request`

Type: object
Dynamic: ✔️
Required: ❌

The elasticsearch value

Can be a json string, in this case, the contentType will be used or a raw Map

`routing`

Type: string
Dynamic: ✔️
Required: ❌

Controls the shard routing of the request.

Using this value to hash the shard and not the id.

Outputs

`rows`

Type: array
SubType: object

The search result fetch

`size`

Type: integer

The size of the rows fetch

`total`

Type: integer

The total of the rows fetch without pagination

Definitions

`ElasticsearchConnection`

`hosts`

Type: array
SubType: string
Dynamic: ✔️
Required: ✔️
Min items: 1

List of http elasticsearch servers

Must be an uri like https://elasticsearch.com:9200 with scheme and port

`basicAuth`

Type: BasicAuth
Dynamic: ❌
Required: ❌

Basic Auth configuration

`headers`

Type: array
SubType: string
Dynamic: ✔️
Required: ❌

List of http headers to be send on every request

Must be an string with key value separated with :, ex: Authorization: Token XYZ

`pathPrefix`

Type: string
Dynamic: ✔️
Required: ❌

Sets the path's prefix for every request used by the http client.

For example, if this is set to /my/path, then any client request will become /my/path/ + endpoint. In essence, every request's endpoint is prefixed by this pathPrefix. The path prefix is useful for when Elasticsearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; it is not intended for other purposes and it should not be supplied in other scenarios.