Request

Send a request to an OpenSearch cluster.

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

Examples

Inserting a document in an index using POST request.

yaml
id: opensearch_request
namespace: company.team

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

Searching for documents using GET request.

yaml
id: opensearch_request
namespace: company.team

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

Deleting document using DELETE request.

yaml
id: opensearch_request
namespace: company.team

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

Properties

connection *OpensearchConnection

The connection properties.

endpoint *string

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

body object

The full body.

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

method string

Default GET

Possible Values

CONNECTCUSTOMDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE

The http method to use.

parameters object

SubType string

Query string parameters.

routing string

Controls the shard routing of the request.

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

Outputs

response object

status integer

Definitions

io.kestra.plugin.opensearch.OpensearchConnection

hosts *array

SubType string

List of HTTP OpenSearch servers.

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

basicAuth OpensearchConnection-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 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 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.opensearch.OpensearchConnection-BasicAuth

password string

Basic auth password.

username string

Basic auth username.

​Request

Request