PluginsElasticsearchTasksRequest

Request​Request

Request Request

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

Send a generic ElasticSearch request.

Examples

Inserting a document in an index using POST request.

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_post
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "POST"
    endpoint: "my_index/_doc/john"
    body:
      name: "john"

Searching for documents using GET request.

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_get
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "GET"
    endpoint: "my_index/_search"
    parameters:
      q: "name:"John Doe""

Deleting document using DELETE request.

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_delete
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "DELETE"
    endpoint: "my_index/_doc/<_id>"

Properties

connection

The connection properties.

body

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

The full body.

Can be a JSON string or raw Map that will be converted to json.

endpoint

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

The path of the request (without scheme, host, port, or prefix).

method

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: GET
  • Possible Values:
    • CONNECT
    • CUSTOM
    • DELETE
    • GET
    • HEAD
    • OPTIONS
    • PATCH
    • POST
    • PUT
    • TRACE

The http method to use.

parameters

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

Query string parameters.

routing

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

Controls the shard routing of the request.

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

Outputs

response

  • Type: object
  • Required: ❌

status

  • Type: integer
  • Required: ❌

Definitions

io.kestra.plugin.elasticsearch.ElasticsearchConnection

Properties

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

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

Properties

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

Basic auth password.

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

Basic auth username.

Was this page helpful?