PluginsTemplateTasks

Scroll​Scroll

Scroll Scroll

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

Scroll over search request.

Get all documents from a search request and store it as Kestra Internal Storage file.

Examples

yaml
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

The connection properties.

contentType

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: JSON
  • Possible Values:
    • CBOR
    • JSON
    • SMILE
    • YAML

The content type of value.

indexes

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

The OpenSearch indices.

Default to all indices.

request

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

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

size

  • Type: integer
  • Required: ❌

The size of the rows fetch

uri

  • Type: string
  • Required: ❌
  • Format: uri

The uri of store result

Definitions

io.kestra.plugin.opensearch.OpensearchConnection

Properties

hosts
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min items: 1

List of HTTP OpenSearch servers.

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

basicAuth

Basic auth configuration.

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

List of HTTP headers to be send on every request.

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

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 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
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

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

trustAllSsl
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Trust all SSL CA certificates.

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

io.kestra.plugin.opensearch.OpensearchConnection-BasicAuth

Properties

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

Basic auth password.

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

Basic auth username.

Was this page helpful?