Put

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

Put an Elasticsearch document

Examples

Put a doc with a Map

id: "put"
type: "io.kestra.plugin.elasticsearch.Put"
connection:
  hosts: 
   - "http://localhost:9200"
index: "my_index"
key: "my_id"
value:
  name: "John Doe"
  city: "Paris"

Put a doc from a json string

id: "put"
type: "io.kestra.plugin.elasticsearch.Put"
index: "my_index"
key: "my_id"
value: "{{ outputs.task_id.data | json }}"

Properties

connection

• Type: ElasticsearchConnection
• Dynamic: ❓
• Required: ✔️

The connection properties.

index

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

The elasticsearch indice

contentType

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

The content type of value

key

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

The elasticsearch id

opType

• Type: string
• Dynamic: ❌
• Required: ❌
• Possible Values:
  • INDEX
  • CREATE
  • UPDATE
  • DELETE

Sets the type of operation to perform.

refreshPolicy

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: NONE
• Possible Values:
  • NONE
  • IMMEDIATE
  • WAIT_UNTIL

Should this request trigger a refresh

an immediate refresh IMMEDIATE, wait for a refresh WAIT_UNTIL, or proceed ignore refreshes entirely NONE.

routing

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

Controls the shard routing of the request.

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

value

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

The elasticsearch value

Can be a string, in this case, the contentType will be used or a raw Map

Outputs

id

• Type: string

The id of the document changed.

result

• Type: string
• Possible Values:
  • CREATED
  • UPDATED
  • DELETED
  • NOT_FOUND
  • NOOP

The change that occurred to the document.

version

• Type: integer

The change that occurred to the document.

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.

strictDeprecationMode

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

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

trustAllSsl

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

Trust all SSL CA certificate

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

BasicAuth

password

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

Basic Auth password

username

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

Basic Auth username