Request
type: "io.kestra.plugin.elasticsearch.Request"
Send a generic elasticsearch request
Examples
id: "request"
type: "io.kestra.plugin.elasticsearch.Request"
connection:
hosts:
- "http://localhost:9200"
method: "POST"
endpoint: "my_index/_doc/john"
body:
name: "john"
Properties
connection
- Type: ElasticsearchConnection
- 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:
OPTIONS
GET
HEAD
POST
PUT
DELETE
TRACE
CONNECT
PATCH
CUSTOM
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
status
- Type: integer
Definitions
ElasticsearchConnection
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
- Type: 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 an 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 leas one warning header as a failure.
trustAllSsl
- Type: boolean
- Dynamic: ❌
- Required: ❌
Trust all SSL CA certificate
Use this if the server is using a self signed ssl certificate.
BasicAuth
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Basic Auth password
username
- Type: string
- Dynamic: ✔️
- Required: ❌
Basic Auth username