Put

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

Put an OpenSearch document.

Examples

Put a document with a Map.

id: opensearch_put
namespace: company.team

tasks:
  - id: put
    type: io.kestra.plugin.opensearch.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.

id: opensearch_put
namespace: company.team

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

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

Properties

connection

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

The connection properties.

index

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

The OpenSearch index.

contentType

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

The content type of value.

key

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

The OpenSearch 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:
  • IMMEDIATE
  • WAIT_UNTIL
  • NONE

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 OpenSearch value.

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

Outputs

id

• Type: string
• Required: ❌

The id of the document changed.

result

• Type: string
• Required: ❌
• Possible Values:
  • Created
  • Deleted
  • NoOp
  • NotFound
  • Updated

The change that occurred to the document.

version

• Type: integer
• Required: ❌

The version of the updated document.

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

• Type: OpensearchConnection-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 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.