Get an OpenSearch document.

yaml
type: "io.kestra.plugin.opensearch.Get"
yaml
id: opensearch_get
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.opensearch.Get
    connection:
      hosts:
        - "http://localhost:9200"
    index: "my_index"
    key: "my_id"
Properties

The connection properties.

Definitions
hosts*Requiredarray
SubTypestring

List of HTTP OpenSearch servers.

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

basicAuth

Basic auth configuration.

passwordstring

Basic auth password.

usernamestring

Basic auth username.

headersarray
SubTypestring

List of HTTP headers to be send on every request.

Must be a string with key value separated with : , ex: Authorization: Token XYZ.

pathPrefixstring

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.

strictDeprecationModebooleanstring

Whether the REST client should return any response containing at least one warning header as a failure.

trustAllSslbooleanstring

Trust all SSL CA certificates.

Use this if the server is using a self signed SSL certificate.

Current version of the document

The specified version must match the current version of the document for the GET request to succeed.

The OpenSearch index.

The OpenSearch id.

Controls the shard routing of the request.

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