Put

Insert a document into an ElasticSearch cluster.

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

Examples

Put a document with a Map.

yaml
id: elasticsearch_put
namespace: company.team

tasks:
  - 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 document from a JSON string.

yaml
id: elasticsearch_put
namespace: company.team

inputs:
  - id: value
    type: JSON
    defaults: {"name": "John Doe", "city": "Paris"}

tasks:
  - id: put
    type: io.kestra.plugin.elasticsearch.Put
    connection:
      hosts:
       - "http://localhost:9200"
    index: "my_index"
    key: "my_id"
    value: "{{ inputs.value }}"

Properties

connection *ElasticsearchConnection

The connection properties.

index *string

The elasticsearch index.

contentType string

Default JSON

Possible Values

CBORJSONSMILEYAML

The content type of value.

key string

The elasticsearch id.

opType string

Possible Values

INDEXCREATEUPDATEDELETE

Sets the type of operation to perform.

refreshPolicy string

Default NONE

Possible Values

IMMEDIATEWAIT_UNTILNONE

Should this request trigger a refresh.

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

routing string

Controls the shard routing of the request.

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

value object

The elasticsearch value.

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

Outputs

id string

The id of the document changed.

result string

Possible Values

CreatedUpdatedDeletedNotFoundNoOp

The change that occurred to the document.

version integer

The version of the updated document.

Definitions

io.kestra.plugin.elasticsearch.ElasticsearchConnection

hosts *array

SubType string

Min items 1

List of HTTP ElasticSearch servers.

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

basicAuth ElasticsearchConnection-BasicAuth

Basic auth configuration.

headers array

SubType string

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 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 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.elasticsearch.ElasticsearchConnection-BasicAuth

password string

Basic auth password.

username string

Basic auth username.

​Put

Put