Scroll
Get all documents from an OpenSearch search request and store it as Kestra Internal Storage file.
type: "io.kestra.plugin.opensearch.Scroll"
Examples
id: opensearch_scroll
namespace: company.team
tasks:
- id: scroll
type: io.kestra.plugin.opensearch.Scroll
connection:
hosts:
- "http://localhost:9200"
indexes:
- "my_index"
request:
query:
term:
name:
value: 'john'
Properties
connection *RequiredNon-dynamicOpensearchConnection
The connection properties.
contentType string
JSON
CBOR
JSON
SMILE
YAML
The content type of value
.
indexes array
The OpenSearch indices.
Default to all indices.
request object
The OpenSearch value.
Can be a JSON string. In this case, the contentType will be used or a raw Map.
routing string
Controls the shard routing of the request.
Using this value to hash the shard and not the id.
Outputs
size integer
The size of the rows fetch
uri string
uri
The uri of store result
Definitions
io.kestra.plugin.opensearch.OpensearchConnection
hosts *Requiredarray
List of HTTP OpenSearch servers.
Must be an URI like https://opensearch.com: 9200
with scheme and port.
basicAuth OpensearchConnection-BasicAuth
Basic auth configuration.
headers array
List of HTTP headers to be send on every request.
Must be a string with key value separated with :
, ex: Authorization: Token XYZ
.
pathPrefix string
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.
strictDeprecationMode booleanstring
Whether the REST client should return any response containing at least one warning header as a failure.
trustAllSsl booleanstring
Trust all SSL CA certificates.
Use this if the server is using a self signed SSL certificate.
io.kestra.plugin.opensearch.OpensearchConnection-BasicAuth
password string
Basic auth password.
username string
Basic auth username.