Search
Send a search request.
Get all documents from a search request and store it as outputs.
type: "io.kestra.plugin.opensearch.Search"
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'
NO
The connection properties.
YES
JSON
CBOR
JSON
SMILE
YAML
The content type of value
.
YES
FETCH
STORE
FETCH
FETCH_ONE
NONE
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.
YES
The OpenSearch indices.
Default to all indices.
YES
The OpenSearch value.
Can be a JSON string. In this case, the contentType will be used or a raw Map.
YES
Controls the shard routing of the request.
Using this value to hash the shard and not the id.
Map containing the first row of fetched data.
Only populated if using fetchType=FETCH_ONE
.
List containing the fetched data.
Only populated if using fetchType=FETCH
.
The size of the rows fetched.
The total of the rows fetched without pagination.
uri
The URI of the stored data.
Only populated if using fetchType=STORE
.
YES
List of HTTP OpenSearch servers.
Must be an URI like https://opensearch.com: 9200
with scheme and port.
NO
Basic auth configuration.
YES
List of HTTP headers to be send on every request.
Must be a string with key value separated with :
, ex: Authorization: Token XYZ
.
YES
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.
YES
YES
YES
Basic auth password.
YES
Basic auth username.