yaml
type: "io.kestra.plugin.opensearch."
Send a generic 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
- Type: OpensearchConnection
- Dynamic: ❌
- Required: ✔️
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.opensearch.OpensearchConnection
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ✔️
- Min items:
1
- Type: OpensearchConnection-BasicAuth
- Dynamic: ❌
- Required: ❌
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
- Type: string
- Dynamic: ✔️
- Required: ❌
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Type: boolean
- Dynamic: ❌
- Required: ❌
hosts
basicAuth
headers
pathPrefix
strictDeprecationMode
trustAllSsl
io.kestra.plugin.opensearch.OpensearchConnection-BasicAuth
- Type: string
- Dynamic: ✔️
- Required: ❌
- Type: string
- Dynamic: ✔️
- Required: ❌