search
Send an OpenSearch search request.

Send an OpenSearch search request.

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

yaml
type: "io.kestra.plugin.opensearch.search"

Examples

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

connection*

The connection properties.

Definitions

io.kestra.plugin.opensearch.OpensearchConnection

hosts*array

SubTypestring

List of HTTP OpenSearch servers.

Must be an URI like https://opensearch.com: 9200 with scheme and port.

basicAuth

Basic auth configuration.

io.kestra.plugin.opensearch.OpensearchConnection-BasicAuth

passwordstring

Basic auth password.

usernamestring

Basic auth username.

headersarray

SubTypestring

List of HTTP headers to be send on every request.

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

pathPrefixstring

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

strictDeprecationModebooleanstring

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

trustAllSslbooleanstring

Trust all SSL CA certificates.

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

contentTypestring

DefaultJSON

Possible Values

CBORJSONSMILEYAML

The content type of value.

fetchTypestring

DefaultFETCH

Possible Values

STOREFETCHFETCH_ONENONE

The way you want to store the data.

FETCH_ONE output the first row, FETCH output all the rows, STORE store all rows in a file, NONE do nothing.

indexesarray

SubTypestring

The OpenSearch indices.

Default to all indices.

requestobject

The OpenSearch value.

Can be a JSON string. In this case, the contentType will be used or a raw Map.

routingstring

Controls the shard routing of the request.

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

Outputs

rowobject

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

rowsarray

SubTypeobject

List containing the fetched data.

Only populated if using fetchType=FETCH.

sizeinteger

The size of the rows fetched.

totalinteger

The total of the rows fetched without pagination.

uristring

Formaturi

The URI of the stored data.

Only populated if using fetchType=STORE.

Opensearch

Enterprise

This sub-group of plugins contains tasks for using Opensearch EE. Opensearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases.

Database