Edit me

Configurations

Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

 ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

HTTP Connection

Name Type Description Default Value Required

Host

 String

ElasticSearch instance host IP or DNS name

x 

Port

 Number

ElasticSearch instance port

9200

 

User Name

 String

Elasticsearch instance username. Keep this blank for anonymous user.

 

Password

 String

Elasticsearch instance password. Keep this blank for anonymous user.

 

Reconnection

 Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

HTTPS Connection

Name Type Description Default Value Required

Host

 String

ElasticSearch instance host IP or DNS name

x 

Port

 Number

ElasticSearch instance port

9200

 

User Name

 String

Elasticsearch instance username. Keep this blank for anonymous user.

 

Password

 String

Elasticsearch instance password. Keep this blank for anonymous user.

 

Type

 String

Type of the TrustStore

jks

 

Path

 String

TrustStore file path

x 

Password

 String

Trust store password

x 

Reconnection

 Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Associated Operations

Operations

Bulk Operation

<elasticsearch:bulk-operation>

Bulk operation makes it possible to perform many index, delete and update operations in a single API call.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Index name on which bulk operation Performed

 

Type

 String

Type name on which bulk operation Performed

 

File

 String

Provide the JSON file path

 

Text

 String

Provide the JSON string

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 Response

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Clear Scroll

<elasticsearch:clear-scroll>

The search contexts used by the Search Scroll operation are automatically deleted when the scroll times out. Clear scroll operation release search contexts as soon as they are not necessary anymore using the Clear Scroll.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scroll ID

 String

Scroll identifier to clear scroll

x 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 ClearScrollResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Close Index

<elasticsearch:close-index>

A closed index has almost no overhead. It is used to close an Index. If you want to keep your data but save resources (memory/CPU), a good alternative to deleting an index is to close them.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

The index to close

x 

Timeout

 String

Time to wait for the all the nodes to acknowledge if the index is closed

 

Mater Node Timeout

 String

Timeout to connect to the master node

 

Indices Opt

 IndexOptions

IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 CloseIndexResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Create Index

<elasticsearch:create-index>

The createIndex Operation allows to instantiate an index.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

The index to create

x 

Index Settings

 Object

Settings for this index

 

Index Settings JSON

 String

Index Settings JSON

 

Type for Mapping

 String

The index type to define index

 

Index Mapping

 Object

The mapping for index type, provided as a JSON string

 

JSON Input file path for mapping

 String

Path of the JSON file. The whole source including all of its sections (mappings, settings and aliases) can be provided in this json file.

 

Index Alias

 String

The alias of the index

 

Timeout

 String

Timeout to wait for the all the nodes to acknowledge the index creation

 

Master Node Timeout

 String

Timeout to connect to the master node

 

Wait for Active Shards

 Number

The number of active shard copies to wait for before the create index

0

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 CreateIndexResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Delete Document

<elasticsearch:delete-document>

Delete Document operation allows to delete a typed JSON document from a specific index based on its id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Name of the index

x 

Type

 String

Type of the index

x 

Document Id

 String

ID of the document

x 

Routing value

 String

Routing is used to determine in which shard the document will reside in

 

Parent value

 String

Parent value of the index request

 

Timeout

 String

Time to wait for primary shard to become available

 

Refresh policy

 Enumeration, one of:

  • NONE

  • IMMEDIATE

  • WAIT_UNTIL

Refresh policy is used to control when changes made by the requests are made visible to search. Option for refresh policy A) true : Refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. B) wait_for : Wait for the changes made by the request to be made visible by a refresh before replying. This doesn?t force an immediate refresh, rather, it waits for a refresh to happen. C) false (default) : Take no refresh related actions. The changes made by this request will be made visible at some point after the request returns.

 

Version

 Number

Version number of the indexed document

0

 

Version Type

 Enumeration, one of:

  • INTERNAL

  • EXTERNAL

  • EXTERNAL_GTE

  • FORCE

Version type: internal, external, external_gte

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 DeleteResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Delete Index

<elasticsearch:delete-index>

The Delete index operation allows to delete an existing index.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

The index to delete

x 

Timeout

 String

Timeout to wait for the all the nodes to acknowledge the index deletion

 

Mater Node Timeout

 String

Timeout to connect to the master node

 

Indices Opts

 IndexOptions

IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 DeleteIndexResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Get Document

<elasticsearch:get-document>

Get Document operation allows to get a typed JSON document from the index based on its id.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Name of the index

x 

Type

 String

Type of the index

x 

Document Id

 String

ID of the document

x 

Source retrieval

 DocumentFetchSourceOptions

Enable or disable source retrieval

 

Routing

 String

Routing is used to determine in which shard the document will reside in

 

Parent

 String

Parent value of the index request

 

Preference value

 String

Preference value

 

Set realtime flag

 Boolean

Set realtime flag

true

 

Refresh

 Boolean

Perform a refresh before retrieving the document

false

 

Version

 Number

Version number of the indexed document

0

 

Version Type

 Enumeration, one of:

  • INTERNAL

  • EXTERNAL

  • EXTERNAL_GTE

  • FORCE

Version type: internal, external, external_gte,

 

Output Mime Type

 String

The mime type of the payload that this operation outputs.

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 String

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Index Document

<elasticsearch:index-document>

Index Document operation adds or updates a typed JSON document in a specific index, making it searchable.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Name of the index

x 

Type

 String

Type of the index

x 

Document Id

 String

ID of the document

x 

Routing

 String

Routing is used to determine in which shard the document will reside in

 

Parent

 String

A parent-child relationship can be established between documents in the same index by making one mapping type the parent of another

 

Timeout

 String

Timeout to wait for primary shard to become available

 

Refresh policy

 Enumeration, one of:

  • NONE

  • IMMEDIATE

  • WAIT_UNTIL

Refresh policy is used to control when changes made by the requests are made visible to search. Option for refresh policy A) true : Refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. B) wait_for : Wait for the changes made by the request to be made visible by a refresh before replying. This doesn?t force an immediate refresh, rather, it waits for a refresh to happen. C) false (default) : Take no refresh related actions. The changes made by this request will be made visible at some point after the request returns.

 

Version

 Number

Version number of the indexed document. It will control the version of the document the operation is intended to be executed against.

0

 

Version Type

 Enumeration, one of:

  • INTERNAL

  • EXTERNAL

  • EXTERNAL_GTE

  • FORCE

Version type: internal, external, external_gte

 

Operation type

 Enumeration, one of:

  • INDEX

  • CREATE

  • UPDATE

  • DELETE

Type of the operation. When create type is used, the index operation will fail if a document by that id already exists in the index.

 

Pipeline

 String

Name of the ingest pipeline to be executed before indexing the document

 

JSON Input file path

 String

Provide the JSON file path

 

Document Source

 Object

Provide the Document source

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 IndexResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Info

<elasticsearch:info>

To retrieve the cluster information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 MainResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Open Index

<elasticsearch:open-index>

Open Index operation allow to open an index.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

The index to open

x 

Timeout

 String

Timeout to wait for the all the nodes to acknowledge the index is opened. It is the time to wait for an open index to become available to elasticsearch.

 

Mater Node Timeout

 String

Timeout to connect to the master node

 

Wait for Active Shards

 Number

The number of active shard copies to wait for

0

 

Indices Opts

 IndexOptions

IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 OpenIndexResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

<elasticsearch:search>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Query Type

 One of:

Different types of Elasticsearch query query configuration

x 

Search Source

 SearchSourceConfiguration

Search source configuration to control the search behavior.

 

Index

 String

Restricts the search request to an index

 

Search Type

 Enumeration, one of:

  • DFS_QUERY_THEN_FETCH

  • QUERY_THEN_FETCH

  • QUERY_AND_FETCH

The type of the search operation to perform

 

Type

 String

Limits the search request to a type

 

Routing

 String

Search the document using routing

 

Scroll Interval Time

 Number

Scroll interval time keep the search context alive(minutes). If value is non-zero, scroll search is initiated.

0

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 SearchResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Search Scroll

<elasticsearch:search-scroll>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scroll Id

 String

Scroll identifier returned in last scroll request

x 

Keep alive time

 Number

Set the scroll interval time keep the search context alive(minutes)

x 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 SearchResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Search Using Json Data

<elasticsearch:search-using-json-data>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Restricts the search request to an index

 

Output Mime Type

 String

The mime type of the payload that this operation outputs.

 

File

 String

Provide the JSON file path

 

Text

 String

Provide the JSON string

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 String

Attributes Type

 StatusLine

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Update Document

<elasticsearch:update-document>

Update Document operation allows to update a document based on a script provided.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Index

 String

Name of the index

x 

Type

 String

Type of the index

x 

Document Id

 String

ID of the document

x 

Routing

 String

Routing is used to determine in which shard the document will reside in

 

Parent

 String

Parent value of the index request

 

Timeout

 String

Time to wait for primary shard to become available

 

Refresh policy

 Enumeration, one of:

  • NONE

  • IMMEDIATE

  • WAIT_UNTIL

Refresh policy is used to control when changes made by the requests are made visible to search. Option for refresh policy A) true : Refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. B) wait_for : Wait for the changes made by the request to be made visible by a refresh before replying. This doesn?t force an immediate refresh, rather, it waits for a refresh to happen. C) false (default) : Take no refresh related actions. The changes made by this request will be made visible at some point after the request returns.

 

Retry on Conflict

 Number

How many times to retry the update operation if the document to update has been changed by another operation between the get and indexing phases of the update operation

0

 

Fetch Source

 Boolean

Enable or disable source retrieval

false

 

Version

 Number

Version number of the indexed document

0

 

Noop Detection

 Boolean

Enable or disable the noop detection

true

 

Scripted Upsert

 Boolean

Indicate that the script must run regardless of whether the document exists or not

false

 

Doc Upsert

 Boolean

Indicate that the partial document must be used as the upsert document if it does not exist yet.

false

 

JSON Input file path

 String

Provide the JSON file path

 

Document Source

 Object

Provide the Document source

 

Target Variable

 String

The name of a variable on which the operation's output will be placed

 

Target Value

 String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

 UpdateResponse

For Configurations.

Throws

  • ELASTICSEARCH:INVALID_CONNECTION  

  • ELASTICSEARCH:CONNECTIVITY  

  • ELASTICSEARCH:RETRY_EXHAUSTED  

  • ELASTICSEARCH:OPERATION_FAILED  

  • ELASTICSEARCH:INVALID_AUTH  

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

 Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

 Number

How often (in ms) to reconnect

Count

 Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

 Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

 Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

 Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Response

Field Type Description Default Value Required

Entity

 HttpEntity

Headers

 Array of Header

Host

 HttpHost

Request Line

 RequestLine

Status Line

 StatusLine

Http Host

Field Type Description Default Value Required

Address

 Any

Host Name

 String

Port

 Number

Scheme Name

 String

Clear Scroll Response

Field Type Description Default Value Required

Num Freed

 Number

Succeeded

 Boolean

Close Index Response

Field Type Description Default Value Required

Acknowledged

 Boolean

Index Options

Field Type Description Default Value Required

Ignore Unavailable

 Boolean

false

Allow No Indices

 Boolean

false

Expand To Open Indices

 Boolean

false

Expand To Closed Indices

 Boolean

false

Allow Aliases To Multiple Indices

 Boolean

false

Forbid Closed Indices

 Boolean

false

Ignore Aliases

 Boolean

false

Create Index Response

Field Type Description Default Value Required

Acknowledged

 Boolean

Shards Acked

 Boolean

Shards Acknowledged

 Boolean

Delete Response

Field Type Description Default Value Required

Forced Refresh

 Boolean

Id

 String

Index

 String

Primary Term

 Number

Result

 Enumeration, one of:

  • CREATED

  • UPDATED

  • DELETED

  • NOT_FOUND

  • NOOP

Seq No

 Number

Shard Id

 ShardId

Shard Info

 ShardInfo

Type

 String

Version

 Number

Shard Id

Field Type Description Default Value Required

Id

 Number

Index

 Index

Index Name

 String

Shard Info

Field Type Description Default Value Required

Failed

 Number

Failures

 Array of Failure

Successful

 Number

Total

 Number

Failure

Field Type Description Default Value Required

Cause

 Any

Delete Index Response

Field Type Description Default Value Required

Acknowledged

 Boolean

Document Fetch Source Options

Field Type Description Default Value Required

Fetch Source

 Boolean

Fetch the source of the search document

true

Include Fields

 Array of String

List of the field that are included into the document source

Exclude Fields

 Array of String

List of the field that are excluded from the document source

Index Response

Field Type Description Default Value Required

Forced Refresh

 Boolean

Id

 String

Index

 String

Primary Term

 Number

Result

 Enumeration, one of:

  • CREATED

  • UPDATED

  • DELETED

  • NOT_FOUND

  • NOOP

Seq No

 Number

Shard Id

 ShardId

Shard Info

 ShardInfo

Type

 String

Version

 Number

Main Response

Field Type Description Default Value Required

Available

 Boolean

Build

 Build

Cluster Name

 ClusterName

Cluster Uuid

 String

Node Name

 String

Version

 Version

Build

Field Type Description Default Value Required

Snapshot

 Boolean

Version

Field Type Description Default Value Required

RC

 Boolean

Alpha

 Boolean

Beta

 Boolean

Release

 Boolean

Open Index Response

Field Type Description Default Value Required

Acknowledged

 Boolean

Shards Acknowledged

 Boolean

Search Response

Field Type Description Default Value Required

Aggregations

 Array of Aggregation

Clusters

 Clusters

Failed Shards

 Number

Hits

 Array of Array of Array of Any

Num Reduce Phases

 Number

Profile Results

 Object

Scroll Id

 String

Shard Failures

 Array of ShardSearchFailure

Skipped Shards

 Number

Successful Shards

 Number

Suggest

 Array of Array of Array of Option

Timed Out

 Boolean

Took

 TimeValue

Total Shards

 Number

Clusters

Field Type Description Default Value Required

Skipped

 Number

Successful

 Number

Total

 Number

Shard Search Failure

Field Type Description Default Value Required

Cause

 Any

Option

Field Type Description Default Value Required

Highlighted

 Text

Score

 Number

Text

 Text

Time Value

Field Type Description Default Value Required

Days

 Number

Days Frac

 Number

Hours

 Number

Hours Frac

 Number

Micros

 Number

Micros Frac

 Number

Millis

 Number

Millis Frac

 Number

Minutes

 Number

Minutes Frac

 Number

Nanos

 Number

Seconds

 Number

Seconds Frac

 Number

String Rep

 String

Search Source Configuration

Field Type Description Default Value Required

From

 Number

Retrieve search result from a certain offset

0

Size

 Number

The number of search hits to return

10

Timeout

 Number

Time allowed to finish the search operation

Sort Order

 Enumeration, one of:

  • ASC

  • DESC

The sort order of search result using default field (_score).

Sort By Field Name

 String

Field name to sort the search result

Fetch Source

 Boolean

Fetch the source of the search document

true

Include Fields

 Array of String

List of the field that are included into the document source

Exclude Fields

 Array of String

List of the field that are excluded from the document source

Profile

 Boolean

Enable the profiling to the execution of search queries

false

Explain

 Boolean

Explain the execution of search queries

false

Terminate After

 Number

The maximum number of documents to collect for each shard

Track Scores

 Boolean

Enable the search source tracking

false

Track Total Hits

 Boolean

Enable the total hits tracking

false

Version

 Boolean

Returns a version for each search hit.

false

Update Response

Field Type Description Default Value Required

Forced Refresh

 Boolean

Get Result

 Array of Array of Any

Id

 String

Index

 String

Primary Term

 Number

Result

 Enumeration, one of:

  • CREATED

  • UPDATED

  • DELETED

  • NOT_FOUND

  • NOOP

Seq No

 Number

Shard Id

 ShardId

Shard Info

 ShardInfo

Type

 String

Version

 Number

Match Query

Field Type Description Default Value Required

Field

 String

Restrict the search request to field

x

Search String

 String

Search text string

x

Fuzziness

 Fuzziness

Enable fuzzy matching on the match query

Fuzzy Transpositions

 Boolean

Allow the fuzzy transpositions match

true

Prefix Length

 Number

Prefix length option on the match query

0

Max Expansions

 Number

Max expansion to control the fuzzy process of the query

50

Operator

 Enumeration, one of:

  • OR

  • AND

Set the match query operator

Lenient

 Boolean

Ignore exceptions caused by data-type mismatches

false

Zero Terms Query

 Enumeration, one of:

  • ALL

  • NONE

Set the zero terms query option

Cutoff Frequency

 Number

Specify an absolute or relative document frequency

0.0

Auto Generate Synonyms Phrase Query

 Boolean

Enable the auto generate synonyms phrase

false

Multi Match Query

Field Type Description Default Value Required

Fields

 Array of String

Restrict the search request to list of field

x

Type

 Enumeration, one of:

  • BEST_FIELDS

  • CROSS_FIELDS

  • MOST_FIELDS

  • PHRASE

  • PHRASE_PREFIX

Type of the multi match query is executed internally

Tie Breaker

 Number

The tie breaker parameter used to select field in a group of field based on score

0.0 - Take the single best score out of multiple field

1.0 - Add together the scores of the multiple field

0.0 < n < 1.0 - Take the single best score plus tie_breaker multiplied by each of the scores from other matching fields.

0.0

Minimum Should Match

 String

Set minimum should match with possible value using integer and percentage.

Search String

 String

Search text string

x

Fuzziness

 Fuzziness

Enable fuzzy matching on the match query

Fuzzy Transpositions

 Boolean

Allow the fuzzy transpositions match

true

Prefix Length

 Number

Prefix length option on the match query

0

Max Expansions

 Number

Max expansion to control the fuzzy process of the query

50

Operator

 Enumeration, one of:

  • OR

  • AND

Set the match query operator

Lenient

 Boolean

Ignore exceptions caused by data-type mismatches

false

Zero Terms Query

 Enumeration, one of:

  • ALL

  • NONE

Set the zero terms query option

Cutoff Frequency

 Number

Specify an absolute or relative document frequency

0.0

Auto Generate Synonyms Phrase Query

 Boolean

Enable the auto generate synonyms phrase

false

Match All Query

Field Type Description Default Value Required

Boost

 Number

Sets the boost value of the query

1.0

Match Phrase Query

Field Type Description Default Value Required

Field

 String

Restrict the search request to field

x

Query String

 String

Search text string

x

Boost

 Number

Sets the boost value of the query

1.0

Analyzer

 String

The analyzer name used to analyze the query string

Match Phrase Prefix Query

Field Type Description Default Value Required

Max Expansions

 Number

Number of suffixes the last term will be expanded

50

Field

 String

Restrict the search request to field

x

Query String

 String

Search text string

x

Boost

 Number

Sets the boost value of the query

1.0

Analyzer

 String

The analyzer name used to analyze the query string

Common Terms Query

Field Type Description Default Value Required

Field Name

 String

Restrict the search request to field

x

Query String

 String

Search text string

x

Analyzer

 String

The analyzer name used to analyze the query string

Boost

 Number

Sets the boost value of the query

0

Cutoff Frequency

 Number

Specify an absolute or relative document frequency

0.0

High Freq Minimum Should Match

 String

Set minimum should match with possible value using integer and percentage.

High Freq Operator

 Enumeration, one of:

  • OR

  • AND

High frequency query operator

Low Freq Minimum Should Match

 String

Set minimum should match with possible value using integer and percentage.

@see <a href="http://google.com">Minimum Should Matchedit</a>

Low Freq Operator

 Enumeration, one of:

  • OR

  • AND

Low frequency query operator

Query String Query

Field Type Description Default Value Required

Allow Leading Wildcard

 Boolean

Allow first wildcard (* or ?) in query string

true

Default Field

 String

The default field for query terms if no prefix field is specified.

Enable Position Increments

 Boolean

Set to true to enable position increments in result queries.

true

Escape

 Boolean

Allow escape in query string

true

Phrase Slop

 Number

Sets the default slop for phrases. If zero, then exact phrase matches are required.

0

Tie Breaker

 Number

The disjunction max tie breaker for multi fields

0

Query String

 String

The actual query to be parsed

x

Field And Boost

 Object

List of the field name and associated field boost

Analyzer

 String

The analyzer name used to analyze the query string

Analyze Wildcard

 Boolean

Analyze the wildcards terms from the query string

true

Auto Generate Synonyms Phrase Query

 Boolean

Enable auto generated synonyms phrase queries

true

Boost

 Number

Sets the boost value of the query

1.0

Default Operator

 Enumeration, one of:

  • OR

  • AND

The default operator used if no explicit query operator is specified

Fuzzy Max Expansions

 Number

Controls the number of terms fuzzy queries will expand to.

50

Fuzzy Prefix Length

 Number

Set the prefix length for fuzzy queries

0

Fuzzy Transpositions

 Boolean

Set to false to disable fuzzy transpositions

true

Lenient

 Boolean

If set to true will cause format based failures (like providing text to a numeric field) to be ignored.

false

Minimum Should Match

 String

Set minimum should match with possible value using integer and percentage.

Quote Field Suffix

 String

A suffix to append to fields for quoted parts of the query string.

Simple Query String

Field Type Description Default Value Required

Simple Query String Flag

 Enumeration, one of:

  • ALL

  • AND

  • ESCAPE

  • FUZZY

  • NEAR

  • NONE

  • NOT

  • OR

  • PHRASE

  • PRECEDENCE

  • PREFIX

  • SLOP

  • WHITESPACE

Specify which parsing flag should be enabled

Query String

 String

The actual query to be parsed

x

Field And Boost

 Object

List of the field name and associated field boost

Analyzer

 String

The analyzer name used to analyze the query string

Analyze Wildcard

 Boolean

Analyze the wildcards terms from the query string

true

Auto Generate Synonyms Phrase Query

 Boolean

Enable auto generated synonyms phrase queries

true

Boost

 Number

Sets the boost value of the query

1.0

Default Operator

 Enumeration, one of:

  • OR

  • AND

The default operator used if no explicit query operator is specified

Fuzzy Max Expansions

 Number

Controls the number of terms fuzzy queries will expand to.

50

Fuzzy Prefix Length

 Number

Set the prefix length for fuzzy queries

0

Fuzzy Transpositions

 Boolean

Set to false to disable fuzzy transpositions

true

Lenient

 Boolean

If set to true will cause format based failures (like providing text to a numeric field) to be ignored.

false

Minimum Should Match

 String

Set minimum should match with possible value using integer and percentage.

Quote Field Suffix

 String

A suffix to append to fields for quoted parts of the query string.