OpenSearch Search

OpenSearch Search

Certified

Execute an OpenSearch search

Runs a search request and either returns rows, the first row, or stores results to Internal Storage; default fetchType is FETCH.

yaml
type: io.kestra.plugin.opensearch.Search
yaml
id: opensearch_search
namespace: company.team

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

Configure OpenSearch connection

Hosts, auth headers, and TLS options reused by every task invocation.

Definitions
hosts*Requiredarray
SubTypestring

OpenSearch HTTP endpoints

One or more host URLs with scheme and port, e.g. https://opensearch.com: 9200; all are used for load-balancing/failover.

basicAuth

Basic auth configuration

passwordstring

Basic auth password

usernamestring

Basic auth username

headersarray
SubTypestring

Additional HTTP headers

Each entry is Key: Value, e.g. Authorization: Token XYZ; rendered per request.

pathPrefixstring

Path prefix for every request

Prepends /my/path to all endpoints when OpenSearch is behind a proxy enforcing a base path; leave unset otherwise.

strictDeprecationModebooleanstring

Fail on warning headers

If true, any response containing an OpenSearch warning header is treated as a failure; defaults to server/client behavior.

trustAllSslbooleanstring

Trust all SSL certificates

INSECURE — disables TLS certificate and hostname verification entirely, allowing man-in-the-middle attacks. Must never be used against production clusters or over untrusted networks. Prefer supplying a trusted CA certificate/trust store instead.

DefaultJSON
Possible Values
CBORJSONSMILEYAML

Payload content type

Format used to parse string requests; defaults to JSON.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Result handling strategy

FETCH returns all rows, FETCH_ONE returns the first row, STORE saves rows to Internal Storage, NONE skips output; defaults to FETCH.

SubTypestring

Target indices

Optional list of indices; defaults to all when empty.

Reference (ref) of the pluginDefaults to apply to this task.

Search request payload

JSON string or Map rendered then parsed into an OpenSearch SearchRequest.

Shard routing key

Hashes routing using this value instead of the document id to colocate related records.

First row fetched

Populated when fetchType is FETCH_ONE.

SubTypeobject

All fetched rows

Populated when fetchType is FETCH.

Number of rows fetched

Total hits without pagination

Formaturi

URI of stored data

Populated when fetchType is STORE.

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

6 blueprints

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints