PLUGINSPLUGIN-ELASTICSEARCHTASKSIO.KESTRA.PLUGIN.ELASTICSEARCH.GET

Get

Table of Contents

Contribute

Get

yaml

type: "io.kestra.plugin.elasticsearch.Get"

Get an Elasticsearch document

Examples

yaml

id: "get"
type: "io.kestra.plugin.elasticsearch.Get"
connection:
  hosts: 
   - "http://localhost:9200"
index: "my_index"
key: "my_id"

Properties

`connection`

Type: ElasticsearchConnection
Dynamic: ❓
Required: ✔️

The connection properties.

`index`

Type: string
Dynamic: ✔️
Required: ✔️

The elasticsearch indice

`key`

Type: string
Dynamic: ✔️
Required: ✔️

The elasticsearch id

`version`

Type: integer
Dynamic: ❌
Required: ✔️

Sets the version

which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.

`routing`

Type: string
Dynamic: ✔️
Required: ❌

Controls the shard routing of the request.

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

Definitions

`ElasticsearchConnection`

`hosts`

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

List of http elasticsearch servers

Must be an uri like https://elasticsearch.com:9200 with scheme and port

`basicAuth`

Type: BasicAuth
Dynamic: ❌
Required: ❌

Basic Auth configuration

`headers`

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

List of http headers to be send on every request

Must be an 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 Elasticsearch 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.