Search Search

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

Send a search request

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

# Examples

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

# Properties

# connection

The connection properties.

# contentType

The content type of value

# indexes

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

The elasticsearch indices

Default to all indices

# request

  • Type: ====
  • 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

# basicAuth

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

# 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

# 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.

# strictDeprecationMode

  • Type: boolean
  • Dynamic:
  • Required:

Whether the REST client should return any response containing at leas one warning header as a failure.

# trustAllSsl

  • Type: boolean
  • Dynamic:
  • Required:

Trust all SSL CA certificate

Use this if the server is using a self signed ssl certificate.

# BasicAuth

# password

  • Type: string
  • Dynamic: ✔️
  • Required:

Basic Auth password

# username

  • Type: string
  • Dynamic: ✔️
  • Required:

Basic Auth username