Nest

Implements several handy alias extensions.

Returns a list of aliases that point to the specified index, simplified version of GetAliases.

The exact indexname we want to know aliases of

Returns a list of aliases that point to the specified index, simplified version of GetAliases.

The exact indexname we want to know aliases of

Returns a list of indices that have the specified aliasName applied to them. Simplified version of GetAliases.

The exact alias name

Returns a list of indices that have the specified aliasName applied to them. Simplified version of GetAliases.

The exact alias name

Implements a convenience extension method for count that defaults to counting over all indices and types.

The count API allows to easily execute a query and get the number of matches for that query. It can be executed across one or more indices and across one or more types. This overload returns a dynamic response and defaults to all types and indices >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html

An optional descriptor to describe the count operation

Implements extensions to Delete that allow for easier by id deletes.

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The name of the index as string The type name of the document you wish to delete The id as string of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The id as int of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The id as string of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The id as int of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The name of the index as string The type name of the document you wish to delete The id as string of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The id as string of the document you want to delete An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The object used to infer the id An optional descriptor to further describe the delete operation

The delete API allows to delete a typed JSON document from a specific index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename The object used to infer the id An optional descriptor to further describe the delete operation

Provides convenience extension methods that make it easier to delete existing indices.

The delete index API allows to delete an existing index. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html

The name of the index to be deleted A descriptor that further describes the parameters for the delete index operation

The delete index API allows to delete an existing index. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html

The name of the index to be deleted A descriptor that further describes the parameters for the delete index operation

Provides GetMany extensions that make it easier to get many documents given a list of ids

Shortcut into the Bulk call that indexes the specified objects http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html

The type used to infer the default index and typename List of objects to index, Id will be inferred (Id property or IdProperty attribute on type) Override the inferred indexname for T Override the inferred typename for T

Shortcut into the Bulk call that indexes the specified objects http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html

Implements Get() extensions that make it easier to get a document given an id

The get API allows to get a typed JSON document from the index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

The type used to infer the default index and typename The string id of the document we want the fetch Optionally override the inferred index name for T Optionally override the inferred typename for T

The get API allows to get a typed JSON document from the index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

The type used to infer the default index and typename The long id of the document we want the fetch Optionally override the inferred index name for T Optionally override the inferred typename for T

The get API allows to get a typed JSON document from the index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

The type used to infer the default index and typename The string id of the document we want the fetch Optionally override the inferred index name for T Optionally override the inferred typename for T

The get API allows to get a typed JSON document from the index based on its id. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

The type used to infer the default index and typename The long id of the document we want the fetch Optionally override the inferred index name for T Optionally override the inferred typename for T

Provides GetMany extensions that make it easier to get many documents given a list of ids

Shortcut into the Bulk call that deletes the specified objects http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html

The type used to infer the default index and typename List of objects to delete Override the inferred indexname for T Override the inferred typename for T

Shortcut into the Bulk call that deletes the specified objects http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html

The type used to infer the default index and typename List of objects to delete Override the inferred indexname for T Override the inferred typename for T

Provides GetMany extensions that make it easier to get many documents given a list of ids

Multi GET API allows to get multiple documents based on an index, type (optional) and id (and possibly routing). The response includes a docs array with all the fetched documents, each element similar in structure to a document provided by the get API. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html

The type used to infer the default index and typename IEnumerable of ids as string for the documents to fetch Optionally override the default inferred index name for T Optionally overiide the default inferred typename for T

The type used to infer the default index and typename IEnumerable of ids as ints for the documents to fetch Optionally override the default inferred index name for T Optionally overiide the default inferred typename for T

Provides convenience extension to open an index by string or type.

The create index API allows to instantiate an index. Elasticsearch provides support for multiple indices, including executing operations across several indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html

The name of the index to be created A descriptor that further describes the parameters for the create index operation

Provides convenience extension to open an index by string or type.

The open and close index APIs allow to close an index, and later on opening it. A closed index has almost no overhead on the cluster (except for maintaining its metadata), and is blocked for read/write operations. A closed index can be opened which will then go through the normal recovery process. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html

The name of the index to be opened

The type used to infer the index name to be opened

The name of the index to be closed

The type used to infer the index name to be closed

Provides extension methods to provide a cleaner scoll API given a scollTime and scrollId

A search request can be scrolled by specifying the scroll parameter. The scroll parameter is a time value parameter (for example: scroll=5m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it. This is very similar in its idea to opening a cursor against a database.

The type that represents the result hits The time the server should wait for the scroll before closing the scan operation The scroll id to continue the scroll operation

Deletes a registered scroll request on the cluster http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html

The scrollId to clear

Deletes a registered scroll request on the cluster http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html

The scrollId to clear

This is a convenience method to deserialize to T using the registered deserializer. NOTE: If you want to deserialize to a NEST response you need to use the overload that takes an ElasticsearchResponse

The type to deserialize to the interface we are extending The string representation of the data to be deserialized

Provides convenience extension methods that make it easier to get the _source for a given document given a string or long id.

Use the /{index}/{type}/{id}/_source endpoint to get just the _source field of the document, without any additional content around it. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html#_source

The type used to infer the default index and typename id as string of the document we want the _source from Optionally override the inferred index name for T Optionally override the inferred type name for T

The type used to infer the default index and typename id as int of the document we want the _source from Optionally override the inferred index name for T Optionally override the inferred type name for T

Provides convenience extension methods to get many _source's given a list of ids.

SourceMany allows you to get a list of T documents out of elasticsearch, internally it calls into MultiGet() Multi GET API allows to get multiple documents based on an index, type (optional) and id (and possibly routing). The response includes a docs array with all the fetched documents, each element similar in structure to a document provided by the get API. >http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html

The type used to infer the default index and typename A list of ids as string Optionally override the default inferred indexname for T Optionally override the default inferred indexname for T

The type used to infer the default index and typename A list of ids as int Optionally override the default inferred indexname for T Optionally override the default inferred indexname for T

The type used to infer the default index and typename A list of ids as string Optionally override the default inferred indexname for T Optionally override the default inferred indexname for T

The type used to infer the default index and typename A list of ids as int Optionally override the default inferred indexname for T Optionally override the default inferred indexname for T

Get a DateTime form of the returned key, only make sense on date_histogram aggregations.

Marker interface for alias operation

The pattern_replace char filter allows the use of a regex to manipulate the characters in a string before analysis.

Splits tokens into tokens and payload whenever a delimiter character is found.

Character used for splitting the tokens.

The type of the payload. int for integer, float for float and identity for characters.

Token filter that generates bigrams for frequently occuring terms. Single terms are still indexed. Note, common_words or common_words_path field is required.

A list of common words to use.

A path (either relative to config location, or absolute) to a list of common words.

If true, common words matching will be case insensitive.

Generates bigrams then removes common words and single terms followed by a common word.

The keyword_repeat token filter Emits each incoming token twice once as keyword and once as a non-keyword to allow an unstemmed version of a term to be indexed side by side with the stemmed version of the term.

Basic support for hunspell stemming. Hunspell dictionaries will be picked up from a dedicated hunspell directory on the filesystem.

If true, dictionary matching will be case insensitive.

A locale for this filter. If this is unset, the lang or language are used instead - so one of these has to be set.

The name of a dictionary.

If only unique terms should be returned, this needs to be set to true.

If only the longest term should be returned, set this to true.

Limits the number of tokens that are indexed per document and field.

The maximum number of tokens that should be indexed per document and field.

If set to true the filter exhaust the stream even if max_token_count tokens have been consumed already.

The pattern_capture token filter, unlike the pattern tokenizer, emits a token for every capture group in the regular expression.

If preserve_original is set to true then it would also emit the original token

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

A list of words to keep.

A path to a words file.

A boolean indicating whether to lower case the words.

Overrides stemming algorithms, by applying a custom mapping, then protecting these terms from being modified by stemmers. Must be placed before any stemming filters.

A list of mapping rules to use.

A path (either relative to config location, or absolute) to a list of mappings.

A token filter of type uppercase that normalizes token text to upper case.

This class allows you to map aspects of a Type's property that influences how NEST treats it.

Override the json property name of a type

Ignore this property completely

- When mapping automatically using MapFromAttributes()

- When Indexing this type do not serialize whatever this value hold

This class allows you to map aspects of a Type's property that influences how NEST treats it.

Override the json property name of a type

Ignore this property completely

- When mapping automatically using MapFromAttributes()

- When Indexing this type do not serialize whatever this value hold

Used to describe request parameters not part of the body. e.q query string or connection configuration overrides

Request parameters for DeleteScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

descriptor for DeleteScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries

Request parameters for GetScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

descriptor for GetScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

Request parameters for PutScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

descriptor for PutScript

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html

Provides a base for descriptors that need to describe a path in the form of

            /{name}

name is mandatory.

Specify the {name} part of the operation

Request parameters for CatIndices

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Set to true to return stats only for primary shards

Verbose mode. Display column headers

descriptor for CatIndices

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Set to true to return stats only for primary shards

Verbose mode. Display column headers

Request parameters for CatShards

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatShards

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatThreadPool

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Enables displaying the complete node ids

descriptor for CatThreadPool

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Enables displaying the complete node ids

Request parameters for CatRecovery

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html

The unit in which to display byte values

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatRecovery

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html

The unit in which to display byte values

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatPlugins

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatPlugins

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatPendingTasks

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatPendingTasks

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatNodes

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatNodes

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatMaster

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatMaster

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatHealth

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Set to false to disable timestamping

Verbose mode. Display column headers

descriptor for CatHealth

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Set to false to disable timestamping

Verbose mode. Display column headers

Request parameters for CatFielddata

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

A comma-separated list of fields to return the fielddata size

descriptor for CatFielddata

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

A comma-separated list of fields to return the fielddata size

Request parameters for CatCount

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatCount

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for CatAllocation

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatAllocation

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html

The unit in which to display byte values

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for ClusterPendingTasks

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html

Return local information, do not retrieve the state from master node (default: false)

Specify timeout for connection to master

descriptor for ClusterPendingTasks

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html

Return local information, do not retrieve the state from master node (default: false)

Specify timeout for connection to master

Request parameters for ClusterStats

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html

Return settings in flat format (default: false)

Whether to return time and byte values in human-readable format.

descriptor for ClusterStats

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html

Return settings in flat format (default: false)

Whether to return time and byte values in human-readable format.

Request parameters for CatAliases

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-aliases.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

descriptor for CatAliases

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-aliases.html

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Comma-separated list of column names to display

Return help information

Verbose mode. Display column headers

Request parameters for IndicesDeleteAlias

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Explicit timestamp for the document

Specify timeout for connection to master

descriptor for IndicesDeleteAlias

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{name}

neither parameter is optional

Explicit timestamp for the document

Specify timeout for connection to master

Request parameters for SnapshotGetRepository

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Return local information, do not retrieve the state from master node (default: false)

descriptor for SnapshotGetRepository

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Provides a base for descriptors that need to describe a path that contains a

            {repository}

routing value

Specify the name of the repository we are targeting

Explicit operation timeout for connection to master node

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesPutAlias

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Explicit timestamp for the document

Specify timeout for connection to master

descriptor for IndicesPutAlias

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{name}

neither parameter is optional

Explicit timestamp for the document

Specify timeout for connection to master

Request parameters for SearchShardsGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

Return local information, do not retrieve the state from master node (default: false)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for SearchShardsGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

Return local information, do not retrieve the state from master node (default: false)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

A descriptor wich describes a search operation for _search_shards

descriptor for SearchShardsGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html

Provides a base for descriptors that need to describe a path in the form of

            /{indices}/{types}

all parameters are optional and will default to the defaults for T

The indices to execute the search on. Defaults to the default index

The index to execute the search on, using the default index for typeof TAlternative. Defaults to the default index

The index to execute the search on. Defaults to the default index

The types to execute the search on. Defaults to the inferred typename of T unless T is dynamic then a type (or AllTypes()) MUST be specified.

The type to execute the search on. Defaults to the inferred typename of T unless T is dynamic then a type (or AllTypes()) MUST be specified.

An alternative type to infer the typename from

Execute search over all indices

Execute search over all types

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

Return local information, do not retrieve the state from master node (default: false)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Provides a base for descriptors that need to describe a path that contains a

            {repository}

routing value

Specify the name of the repository we are targeting

Request parameters for SnapshotStatus

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html

Explicit operation timeout for connection to master node

descriptor for SnapshotStatus

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html

Explicit operation timeout for connection to master node

Request parameters for IndicesRecoveryForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html

Whether to display detailed information about shard recovery

Display only those recoveries that are currently on-going

Whether to return time and byte values in human-readable format.

descriptor for IndicesRecoveryForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html

Provides a base for descriptors that need to describe a path in the form of

            /{indices}

{indices} is optional

Whether to display detailed information about shard recovery

Display only those recoveries that are currently on-going

Whether to return time and byte values in human-readable format.

Based on the type information present in this descriptor create method that takes the returned _source and hit and returns the ClrType it should deserialize too. This is so that Documents[A] can contain actual instances of subclasses B, C as well. If you specify types using .Types(typeof(B), typeof(C)) then NEST can automagically create a TypeSelector based on the hits _type property.

Request parameters for SearchTemplateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify the node or shard the operation should be performed on (default: random)

A comma-separated list of specific routing values

Specify how long a consistent view of the index should be maintained for scrolled search

Search operation type

Request parameters for SearchTemplateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify the node or shard the operation should be performed on (default: random)

A comma-separated list of specific routing values

Specify how long a consistent view of the index should be maintained for scrolled search

Search operation type

descriptor for SearchTemplateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify the node or shard the operation should be performed on (default: random)

A comma-separated list of specific routing values

Specify how long a consistent view of the index should be maintained for scrolled search

Search operation type

Whether conditionless queries are allowed or not

Request parameters for IndicesExistsTemplateForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html

Return local information, do not retrieve the state from master node (default: false)

descriptor for IndicesExistsTemplateForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetAliasForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

descriptor for IndicesGetAliasForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesExistsAliasForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

descriptor for IndicesExistsAliasForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetFieldMappingForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html

Whether the default mapping values should be returned as well

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetFieldMappingForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html

Whether the default mapping values should be returned as well

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

descriptor for IndicesGetFieldMappingForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html

Provides a base for descriptors that need to describe a path in the form of

            /{indices}/{types/{Fields}

{types} is optional, {indices} is too, {Fields} is mandatory

Force the operation to hit _all indices

Specify multiple indices by string

Specify multiple indices by stating the types you are searching on. Each type will be asked for their default index and dedupped.

Use the default index of T

limit the types to operate on by specifiying them by string

limit the types to operate on by specifying the CLR types, the type names will be inferred.

Limit the operation on type T

Specify the fields to operate on

Whether the default mapping values should be returned as well

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for MpercolateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

descriptor for MpercolateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{type}

{index} is optional and so is {type} and will NOT fallback to the defaults of T type can only be specified in conjuction with index.

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for NodesHotThreadsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html

The interval for the second sampling of threads

Number of samples of thread stacktrace (default: 10)

Specify the number of threads to provide information for (default: 3)

The type to sample (default: cpu)

descriptor for NodesHotThreadsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html

The interval for the second sampling of threads

Number of samples of thread stacktrace (default: 10)

Specify the number of threads to provide information for (default: 3)

The type to sample (default: cpu)

Request parameters for NodesShutdownForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html

Set the delay for the operation (default: 1s)

Exit the JVM as well (default: true)

descriptor for NodesShutdownForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html

Provides a base for descriptors that need to describe a path in the form of

            /{nodeid}

node id is optional

Specify the {name} part of the operation

Set the delay for the operation (default: 1s)

Exit the JVM as well (default: true)

Provides a base for descriptors that need to describe a path in the form of

            /{indices}/{types/{name}

{types} is optional, {indices} is too but needs an explicit AllIndices().

Specify multiple indices by string

Specify multiple indices by stating the types you are searching on. Each type will be asked for their default index and dedupped.

Use the default index of T

limit the types to operate on by specifiying them by string

limit the types to operate on by specifying the CLR types, the type names will be inferred.

Limit the operation on type T

Specify the {name} part of the operation

Request parameters for Ping

            http://www.elasticsearch.org/guide/

descriptor for Ping

            http://www.elasticsearch.org/guide/

Describe a get operation for the mlt_query docs property

Use a different type to lookup

Describe a get operation for the mlt_query docs property

Use a different type to lookup

Request parameters for IndicesExistsType

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

descriptor for IndicesExistsType

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{type}

Where neither parameter is optional

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Provides NEST's ElasticClient with configurationsettings

Control how NEST's behaviour.

This calls SetDefaultTypenameInferrer with an implementation that will pluralize type names. This used to be the default prior to Nest 0.90

Allows you to update internal the json.net serializer settings to your liking

Add a custom JsonConverter to the build in json serialization by passing in a predicate for a type. This is faster then adding them using AddJsonConverters() because this way they will be part of the cached Json.net contract for a type.

Index to default to when no index is specified.

When null/empty/not set might throw NRE later on when not specifying index explicitly while indexing.

By default NEST camelCases property names (EmailAddress => emailAddress) that do not have an explicit propertyname either via an ElasticProperty attribute or because they are part of Dictionary where the keys should be treated verbatim.

            Here you can register a function that transforms propertynames (default casing, pre- or suffixing)

Allows you to override how type names should be represented, the default will call .ToLowerInvariant() on the type's name.

Map types to a index names. Takes precedence over SetDefaultIndex().

Allows you to override typenames, takes priority over the global SetDefaultTypeNameInferrer()

Instantiate a new connectionsettings object that proves ElasticClient with configuration values

A single uri representing the root of the node you want to connect to defaults to http://localhost:9200 The default index/alias name used for operations that expect an index/alias name, By specifying it once alot of magic string can be avoided. You can also specify specific default index/alias names for types using .SetDefaultTypeIndices( If you do not specify this, NEST might throw a runtime exception if an explicit indexname was not provided for a call

Instantiate a new connectionsettings object that proves ElasticClient with configuration values

A connection pool implementation that'll tell the client what nodes are available The default index/alias name used for operations that expect an index/alias name, By specifying it once alot of magic string can be avoided. You can also specify specific default index/alias names for types using .SetDefaultTypeIndices( If you do not specify this, NEST might throw a runtime exception if an explicit indexname was not provided for a call

DescriptorFor is a marker to rename unintuitive generated elasticsearch operation names

Create a strongly typed string representation of the path to a property i.e p => p.Arrary.First().SubProperty.Field will return 'array.subProperty.field'

The type of the object The path we want to specify An optional ^boost postfix, only make sense with queries

Create a strongly typed string representation of the name to a property i.e p => p.Arrary.First().SubProperty.Field will return 'field'

The type of the object The path we want to specify An optional ^boost postfix, only make sense with queries

Represents a typed container for property names i.e "property" in "field.nested.property";

Represents a typed container for object paths "field.nested.property";

Request parameters for ClusterGetSettings

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html

Return settings in flat format (default: false)

Explicit operation timeout for connection to master node

Explicit operation timeout

descriptor for ClusterGetSettings

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html

Return settings in flat format (default: false)

Explicit operation timeout for connection to master node

Explicit operation timeout

Request parameters for ClusterPutSettings

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html

Return settings in flat format (default: false)

descriptor for ClusterPutSettings

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html

Return settings in flat format (default: false)

Request parameters for SnapshotDelete

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

descriptor for SnapshotDelete

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Provides a base for descriptors that need to describe a path that contains a

            {repository}

routing value

Specify the name of the repository we are targeting

Explicit operation timeout for connection to master node

Describe the query to perform using the static Query class

Request parameters for ExplainGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html

Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

The analyzer for the query string query

The default operator for query string query (AND or OR)

The default field for query string query (default: _all)

A comma-separated list of fields to return in the response

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

Specify whether query terms should be lowercased

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Query in the Lucene query string syntax

Specific routing value

The URL-encoded query definition (instead of using the request body)

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Request parameters for ExplainGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html

Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

The analyzer for the query string query

The default operator for query string query (AND or OR)

The default field for query string query (default: _all)

A comma-separated list of fields to return in the response

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

Specify whether query terms should be lowercased

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Query in the Lucene query string syntax

Specific routing value

The URL-encoded query definition (instead of using the request body)

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

descriptor for ExplainGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{type}/{id}

if one of the parameters is not explicitly specified this will fall back to the defaults for type T

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{type}/{id}

if one of the parameters is not explicitly specified this will fall back to the defaults for type this version won't throw if any of the parts are inferred to be emptyT

Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

The analyzer for the query string query

The default operator for query string query (AND or OR)

The default field for query string query (default: _all)

A comma-separated list of fields to return in the response

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

Specify whether query terms should be lowercased

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Query in the Lucene query string syntax

Specific routing value

The URL-encoded query definition (instead of using the request body)

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Visit the query container just before we dispatch into the query it holds

Visit every query item just before they are visited by their specialized Visit() implementation

The IQuery object that will be visited

Visit the filter container just before we dispatch into the filter it holds

Visit every filer item just before they are visited by their specialized Visit() implementation

The IFilterBase object that will be visited

The current depth of the node being visited

Hints the relation with the parent, i,e queries inside a Must clause will have VisitorScope.Must set.

Request parameters for AbortBenchmark

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html

Request parameters for Bulk

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html

Explicit write consistency setting for the operation

Refresh the index after performing the operation

Explicitely set the replication type

Specific routing value

Explicit operation timeout

Default document type for items which don't provide one

Request parameters for CatHelp

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat.html

Return help information

Request parameters for ClearScroll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html

Request parameters for ClusterHealth

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html

Specify the level of detail for returned information

Return local information, do not retrieve the state from master node (default: false)

Explicit operation timeout for connection to master node

Explicit operation timeout

Wait until the specified number of shards is active

Wait until the specified number of nodes is available

Wait until the specified number of relocating shards is finished

Wait until cluster is in a specific state

Request parameters for ClusterReroute

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html

Simulate the operation only and return the resulting state

Return an explanation of why the commands can or cannot be executed

Don't return cluster state metadata (default: false)

Explicit operation timeout for connection to master node

Explicit operation timeout

Request parameters for ClusterState

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html

Return local information, do not retrieve the state from master node (default: false)

Specify timeout for connection to master

Return settings in flat format (default: false)

Request parameters for Count

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Include only documents with a specific `_score` value in the result

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

The URL-encoded query definition (instead of using the request body)

Request parameters for CountPercolateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html

A comma-separated list of specific routing values

Specify the node or shard the operation should be performed on (default: random)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

The index to count percolate the document into. Defaults to index.

The type to count percolate document into. Defaults to type.

Explicit version number for concurrency control

Specific version type

Request parameters for Delete

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html

Specific write consistency setting for the operation

ID of parent document

Refresh the index after performing the operation

Specific replication type

Specific routing value

Explicit operation timeout

Explicit version number for concurrency control

Specific version type

Request parameters for DeleteByQuery

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html

The analyzer to use for the query string

Specific write consistency setting for the operation

The default operator for query string query (AND or OR)

The field to use as default where no field prefix is given in the query string

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specific replication type

Query in the Lucene query string syntax

Specific routing value

The URL-encoded query definition (instead of using the request body)

Explicit operation timeout

Request parameters for DeleteTemplate

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html

Request parameters for Exists

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

Request parameters for Get

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

A comma-separated list of fields to return in the response

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Explicit version number for concurrency control

Specific version type

Request parameters for GetSource

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Explicit version number for concurrency control

Specific version type

Request parameters for GetTemplate

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html

Request parameters for Index

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html

Explicit write consistency setting for the operation

Explicit operation type

ID of the parent document

Refresh the index after performing the operation

Specific replication type

Specific routing value

Explicit operation timeout

Explicit timestamp for the document

Expiration time for the document

Explicit version number for concurrency control

Specific version type

Request parameters for IndicesAnalyzeGetForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html

The name of the analyzer to use

A comma-separated list of character filters to use for the analysis

Use the analyzer configured for this field (instead of passing the analyzer name)

A comma-separated list of filters to use for the analysis

The name of the index to scope the operation

With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)

The text on which the analysis should be performed (when request body is not used)

The name of the tokenizer to use for the analysis

Format of the output

Request parameters for IndicesClearCacheForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html

Clear field data

A comma-separated list of fields to clear when using the `field_data` parameter (default: all)

Clear filter caches

A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)

Clear ID caches for parent/child

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

A comma-separated list of index name to limit the operation

Clear the recycler cache

Request parameters for IndicesClose

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html

Explicit operation timeout

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for IndicesCreate

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html

Explicit operation timeout

Specify timeout for connection to master

Request parameters for IndicesDelete

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html

Explicit operation timeout

Specify timeout for connection to master

Request parameters for IndicesDeleteMapping

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html

Specify timeout for connection to master

Request parameters for IndicesDeleteWarmer

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html

Specify timeout for connection to master

Request parameters for IndicesExists

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesFlushForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html

Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)

If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for IndicesGetAliasesForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Explicit operation timeout

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetMappingForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetSettingsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return settings in flat format (default: false)

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesGetWarmerForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesOpen

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html

Explicit operation timeout

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for IndicesOptimizeForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html

Does an _optimize on all indices (unless bounded by setting the Indices property).

Does an _optimize on /{index}/_optimize

Does an _optimize on /{indices}/_optimize

Specify whether the index should be flushed after performing the operation (default: true)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

The number of segments the index should be merged into (default: dynamic)

Specify whether the operation should only expunge deleted documents

TODO: ?

Specify whether the request should block until the merge process is finished (default: true)

Force a merge operation to run, even if there is a single segment in the index (default: false)

Request parameters for IndicesPutMapping

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html

Specify whether to ignore conflicts while updating the mapping (default: false)

Explicit operation timeout

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for IndicesPutSettingsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-update-settings.html

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return settings in flat format (default: false)

Request parameters for IndicesPutTemplateForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html

Whether the index template should only be added if new or can also replace an existing one

Explicit operation timeout

Specify timeout for connection to master

Return settings in flat format (default: false)

Request parameters for IndicesPutWarmerForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm

Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm.

Request parameters for IndicesRefreshForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Force a refresh even if not required

TODO: ?

Request parameters for IndicesSegmentsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-segments.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Whether to return time and byte values in human-readable format.

TODO: ?

Request parameters for IndicesStatsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-stats.html

A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)

A comma-separated list of fields for `fielddata` index metric (supports wildcards)

A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)

A comma-separated list of search groups for `search` index metric

Whether to return time and byte values in human-readable format.

Return stats aggregated at cluster, index or shard level

Request parameters for IndicesStatusForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-status.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Whether to return time and byte values in human-readable format.

TODO: ?

Return information about shard recovery

TODO: ?

Request parameters for IndicesUpdateAliasesForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html

Request timeout

Specify timeout for connection to master

Request parameters for IndicesValidateQueryGetForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html

Return detailed information about the error

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

TODO: ?

The URL-encoded query definition (instead of using the request body)

Query in the Lucene query string syntax

Request parameters for Info

            http://www.elasticsearch.org/guide/

Request parameters for ListBenchmarks

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html

Request parameters for MgetGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html

A comma-separated list of fields to return in the response

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Request parameters for MltGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html

The boost factor

The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored

The maximum query terms to be included in the generated query

The minimum length of the word: longer words will be ignored

The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored

The term frequency as percent: terms with lower occurence in the source document will be ignored

The minimum length of the word: shorter words will be ignored

Specific fields to perform the query against

How many terms have to match in order to consider the document a match (default: 0.3)

Specific routing value

The offset from which to return results

A comma-separated list of indices to perform the query against (default: the index containing the document)

The search query hint

A scroll search request definition

The number of documents to return (default: 10)

A specific search request definition (instead of using the request body)

Specific search type (eg. `dfs_then_fetch`, `count`, etc)

A comma-separated list of types to perform the query against (default: the same type as the document)

A list of stop words to be ignored

Request parameters for MsearchGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html

Search operation type

Request parameters for MtermvectorsGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html

Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".

Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".

Request parameters for NodesInfoForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html

Return settings in flat format (default: false)

Whether to return time and byte values in human-readable format.

Request parameters for NodesStatsForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html

A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)

A comma-separated list of fields for `fielddata` index metric (supports wildcards)

A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)

A comma-separated list of search groups for `search` index metric

Whether to return time and byte values in human-readable format.

Return indices stats aggregated at node, index or shard level

A comma-separated list of document types for the `indexing` index metric

Request parameters for PercolateGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html

A comma-separated list of specific routing values

Specify the node or shard the operation should be performed on (default: random)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

The index to percolate the document into. Defaults to index.

The type to percolate document into. Defaults to type.

Explicit version number for concurrency control

Specific version type

Request parameters for ScrollGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html

Request parameters for SearchGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html

The analyzer to use for the query string

Specify whether wildcard and prefix queries should be analyzed (default: false)

The default operator for query string query (AND or OR)

The field to use as default where no field prefix is given in the query string

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

Specify whether query terms should be lowercased

Specify the node or shard the operation should be performed on (default: random)

A comma-separated list of specific routing values

Specify how long a consistent view of the index should be maintained for scrolled search

Search operation type

Specific 'tag' of the request for logging and statistical purposes

Specify which field to use for suggestions

Specify suggest mode

How many suggestions to return in response

The source text for which the suggestions should be returned

Request parameters for SnapshotCreate

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Should this request wait until the operation has completed before returning

Request parameters for SnapshotCreateRepository

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Explicit operation timeout

Request parameters for SnapshotDeleteRepository

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Explicit operation timeout

Request parameters for SnapshotGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Request parameters for SnapshotRestore

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

Should this request wait until the operation has completed before returning

Request parameters for Suggest

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

The URL-encoded request definition (instead of using request body)

Request parameters for TermvectorGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html

Specifies if total term frequency and document frequency should be returned.

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.

A comma-separated list of fields to return.

Specifies if term offsets should be returned.

Specifies if term positions should be returned.

Specifies if term payloads should be returned.

Specify the node or shard the operation should be performed on (default: random).

Specific routing value.

Parent id of documents.

Request parameters for Update

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html

Explicit write consistency setting for the operation

The script language (default: mvel)

ID of the parent document

Refresh the index after performing the operation

Specific replication type

Specify how many times should the operation be retried when a conflict occurs (default: 0)

Specific routing value

The URL-encoded script definition (instead of using request body)

Explicit operation timeout

Explicit timestamp for the document

Expiration time for the document

Explicit version number for concurrency control

Specific version type

Request parameters for Count

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Include only documents with a specific `_score` value in the result

Specify the node or shard the operation should be performed on (default: random)

Specific routing value

The URL-encoded query definition (instead of using the request body)

Request parameters for Delete

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html

Specific write consistency setting for the operation

ID of parent document

Refresh the index after performing the operation

Specific replication type

Specific routing value

Explicit operation timeout

Explicit version number for concurrency control

Specific version type

Request parameters for DeleteByQuery

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html

The analyzer to use for the query string

Specific write consistency setting for the operation

The default operator for query string query (AND or OR)

The field to use as default where no field prefix is given in the query string

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specific replication type

Query in the Lucene query string syntax

Specific routing value

The URL-encoded query definition (instead of using the request body)

Explicit operation timeout

Request parameters for Exists

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

Request parameters for Get

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

A comma-separated list of fields to return in the response

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Explicit version number for concurrency control

Specific version type

Request parameters for GetSource

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html

The ID of the parent document

Specify the node or shard the operation should be performed on (default: random)

Specify whether to perform the operation in realtime or search mode

Refresh the shard containing the document before performing the operation

Specific routing value

True or false to return the _source field or not, or a list of fields to return

A list of fields to exclude from the returned _source field

A list of fields to extract and return from the _source field

Explicit version number for concurrency control

Specific version type

Request parameters for IndicesDeleteMapping

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html

Specify timeout for connection to master

Request parameters for IndicesGetMappingForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Return local information, do not retrieve the state from master node (default: false)

Request parameters for IndicesPutMapping

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html

Calls putmapping on /_all/{type}

Calls putmapping on /{indices}/{type}

Calls putmapping on /{index}/{type}

Specify whether to ignore conflicts while updating the mapping (default: false)

Explicit operation timeout

Specify timeout for connection to master

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Request parameters for IndicesValidateQueryGetForAll

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html

Return detailed information about the error

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

TODO: ?

The URL-encoded query definition (instead of using the request body)

Query in the Lucene query string syntax

Request parameters for MltGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html

The boost factor

The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored

The maximum query terms to be included in the generated query

The minimum length of the word: longer words will be ignored

The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored

The term frequency as percent: terms with lower occurence in the source document will be ignored

The minimum length of the word: shorter words will be ignored

Specific fields to perform the query against

How many terms have to match in order to consider the document a match (default: 0.3)

Specific routing value

The offset from which to return results

A comma-separated list of indices to perform the query against (default: the index containing the document)

The search query hint

A scroll search request definition

The number of documents to return (default: 10)

A specific search request definition (instead of using the request body)

Specific search type (eg. `dfs_then_fetch`, `count`, etc)

A comma-separated list of types to perform the query against (default: the same type as the document)

A list of stop words to be ignored

Request parameters for SearchGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html

The analyzer to use for the query string

Specify whether wildcard and prefix queries should be analyzed (default: false)

The default operator for query string query (AND or OR)

The field to use as default where no field prefix is given in the query string

Whether specified concrete indices should be ignored when unavailable (missing or closed)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

Specify whether query terms should be lowercased

Specify the node or shard the operation should be performed on (default: random)

A comma-separated list of specific routing values

Specify how long a consistent view of the index should be maintained for scrolled search

Search operation type

Specific 'tag' of the request for logging and statistical purposes

Specify which field to use for suggestions

Specify suggest mode

How many suggestions to return in response

The source text for which the suggestions should be returned

Request parameters for TermvectorGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html

Specifies if total term frequency and document frequency should be returned.

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.

A comma-separated list of fields to return.

Specifies if term offsets should be returned.

Specifies if term positions should be returned.

Specifies if term payloads should be returned.

Specify the node or shard the operation should be performed on (default: random).

Specific routing value.

Parent id of documents.

ElasticClient is NEST's strongly typed client which exposes fully mapped elasticsearch endpoints

Helper method that allows you to reindex from one index into another using SCAN and SCROLL.

An IObservable you can subscribe to to listen to the progress of the reindexation process

The type that represents the result hits A descriptor that describes the scroll operation A query response holding T hits as well as the ScrollId for the next scroll operation

The update API allows to update a document based on a script provided. The operation gets the document (collocated with the shard) from the index, runs the script (with optional script language and parameters), and index back the result (also allows to delete, or ignore the operation). It uses versioning to make sure no updates have happened during the "get" and "reindex". http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html

The type to describe the document to be updated a descriptor that describes the update operation

Change specific index level settings in real time. Note not all index settings CAN be updated. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html

A descriptor that strongly types all the updateable settings

The validate API allows a user to validate a potentially expensive query without executing it. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html

The type used to describe the query A descriptor that describes the query operation

The open and close index APIs allow to close an index, and later on opening it. A closed index has almost no overhead on the cluster (except for maintaining its metadata), and is blocked for read/write operations. A closed index can be opened which will then go through the normal recovery process. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html

A descriptor thata describes the open index operation

The open and close index APIs allow to close an index, and later on opening it. A closed index has almost no overhead on the cluster (except for maintaining its metadata), and is blocked for read/write operations. A closed index can be opened which will then go through the normal recovery process. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html

A descriptor thata describes the close index operation

The refresh API allows to explicitly refresh one or more index, making all operations performed since the last refresh available for search. The (near) real-time capabilities depend on the index engine used. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html

A descriptor that describes the parameters for the refresh operation

Provide low level segments information that a Lucene index (shard level) is built with. Allows to be used to provide more information on the state of a shard and an index, possibly optimization information, data "wasted" on deletes, and so on. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html

A descriptor that describes the parameters for the segments operation

The cluster state API allows to get a comprehensive state information of the whole cluster. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html

A descriptor that describes the parameters for the cluster state operation

Allows to put a warmup search request on a specific index (or indices), with the body composing of a regular search request. Types can be provided as part of the URI if the search request is designed to be run only against the specific types. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html#warmer-adding

The name for the warmer that you want to register A descriptor that further describes what the warmer should look like

Getting a warmer for specific index (or alias, or several indices) based on its name. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html#warmer-retrieving

The name of the warmer to get An optional selector specifying additional parameters for the get warmer operation

Deletes a warmer http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html#removing

The name of the warmer to delete An optional selector specifying additional parameters for the delete warmer operation

Gets an index template http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html#getting

The name of the template to get An optional selector specifying additional parameters for the get template operation

Index templates allow to define templates that will automatically be applied to new indices created. The templates include both settings and mappings, and a simple pattern template that controls if the template will be applied to the index created. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html

The name of the template to register An optional selector specifying additional parameters for the put template operation

Deletes an index template http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html#delete

The name of the template to delete An optional selector specifying additional parameters for the delete template operation

Unregister a percolator http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html

The name for the percolator An optional descriptor describing the unregister percolator operation further

The type to infer the index/type from, will also be used to strongly type the query The name for the percolator An optional descriptor describing the register percolator operation further

Percolate a document http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html

The type to infer the index/type from, and of the object that is being percolated An optional descriptor describing the percolate operation further

Percolate a document but only return the number of matches not the matches itself http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html

The type to infer the index/type from, and of the object that is being percolated The object to percolator An optional descriptor describing the percolate operation further

The put mapping API allows to register specific mapping definition for a specific type. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html

The type we want to map in elasticsearch A descriptor to describe the mapping of our type

The get mapping API allows to retrieve mapping definitions for an index or index/type. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html

A descriptor that describes the parameters for the get mapping operation

Allow to delete a mapping (type) along with its data. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html

A descriptor that describes the parameters for the delete mapping operation

The flush API allows to flush one or more indices through an API. The flush process of an index basically frees memory from the index by flushing data to the index storage and clearing the internal transaction log. By default, Elasticsearch uses memory heuristics in order to automatically trigger flush operations as required in order to clear memory. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html

A descriptor that describes the parameters for the flush operation

The get settings API allows to retrieve settings of index/indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html

A descriptor that describes the parameters for the get index settings operation

The delete index API allows to delete an existing index. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html

A descriptor that describes the parameters for the delete index operation

The clear cache API allows to clear either all caches or specific cached associated with one ore more indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html

A descriptor that describes the parameters for the clear cache operation

A descriptor that describes the parameters for the create index operation

Does a request to the root of an elasticsearch node

A descriptor to further describe the root operation

Indices level stats provide statistics on different operations happening on an index. The API provides statistics on the index level scope (though most stats can also be retrieved using node level scope). http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html

Optionaly further describe the indices stats operation

The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html

An optional descriptor to further describe the nodes info operation

The cluster nodes stats API allows to retrieve one or more (or all) of the cluster nodes statistics. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html

An optional descriptor to further describe the nodes stats operation

An API allowing to get the current hot threads on each node in the cluster.

An optional descriptor to further describe the nodes hot threads operation

Allows to shutdown one or more (or all) nodes in the cluster. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html#cluster-nodes-shutdown

A descriptor that describes the nodes shutdown operation

Used to check if the index (indices) exists or not. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-exists.html

A descriptor that describes the index exist operation

The more like this (mlt) API allows to get documents that are "like" a specified document. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html

Type used to infer the default index and typename and used to describe the search A descriptor that describes the more like this operation

The cluster health API allows to get a very simple status on the health of the cluster. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html

An optional descriptor to further describe the cluster health operation

allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

A descriptor that describes the cluster stats operation

Performs the analysis process on a text and return the tokens breakdown of the text. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html

A descriptor that describes the analyze operation

The search API allows to execute a search query and get back search hits that match the query. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html

The type used to infer the index and typename as well describe the query strongly typed A descriptor that describes the parameters for the search operation The type used to infer the index and typename as well describe the query strongly typed A descriptor that describes the parameters for the search operation

The /_search/template endpoint allows to use the mustache language to pre render search requests, before they are executed and fill existing templates with template parameters.

The type used to infer the index and typename as well describe the query strongly typed A descriptor that describes the parameters for the search operation

The multi search API allows to execute several search requests within the same API. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html

A descriptor that describes the search operations on the multi search api

The count API allows to easily execute a query and get the number of matches for that query. It can be executed across one or more indices and across one or more types. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html

The type used to infer the default index and typename as well as describe the strongly typed parts of the query An optional descriptor to further describe the count operation

The delete by query API allows to delete documents from one or more indices and one or more types based on a query. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html

The type used to infer the default index and typename as well as describe the strongly typed parts of the query An optional descriptor to further describe the delete by query operation

The bulk API makes it possible to perform many index/delete operations in a single API call. This can greatly increase the indexing speed. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html

A descriptor the describe the index/create/delete operation for this bulk operation

The index API adds or updates a typed JSON document in a specific index, making it searchable. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html

The type used to infer the default index and typename The object to be indexed, Id will be inferred (Id property or IdProperty attribute on type) Optionally furter describe the index operation i.e override type/index/id

The delete API allows to delete a typed JSON document from a specific index based on its id. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html

The type used to infer the default index and typename Describe the delete operation, i.e type/index/id

Multi GET API allows to get multiple documents based on an index, type (optional) and id (and possibly routing). The response includes a docs array with all the fetched documents, each element similar in structure to a document provided by the get API. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html

A descriptor describing which documents should be fetched

Use the /{index}/{type}/{id}/_source endpoint to get just the _source field of the document, without any additional content around it. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html#_source

The type used to infer the default index and typename A descriptor that describes which document's source to fetch

Use the /{index}/{type}/{id} to get the document and its metadata http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html#_source

The type used to infer the default index and typename A descriptor that describes which document's source to fetch

APIs in elasticsearch accept an index name when working against a specific index, and several indices when applicable. The index aliases API allow to alias an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliases indices.i An alias can also be associated with a filter that will automatically be applied when searching, and routing values. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

A desriptor that describes the parameters for the alias operation

The get index alias api allows to filter by alias name and index name. This api redirects to the master and fetches the requested index aliases, if available. This api only serialises the found index aliases. Difference with GetAlias is that this call will also return indices without aliases set http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#alias-retrieving

A descriptor that describes which aliases/indexes we are interested int

The get index alias api allows to filter by alias name and index name. This api redirects to the master and fetches the requested index aliases, if available. This api only serialises the found index aliases. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#alias-retrieving

A descriptor that describes which aliases/indexes we are interested int

Add a single index alias http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#alias-adding

A descriptor that describes the put alias request

Delete an index alias http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#deleting

A descriptor that describes the delete alias request

The optimize API allows to optimize one or more indices through an API. The optimize process basically optimizes the index for faster search operations (and relates to the number of segments a Lucene index holds within each shard). The optimize operation allows to reduce the number of segments by merging them. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html

An optional descriptor that further describes the optimize operation, i.e limit it to one index

The indices status API allows to get a comprehensive status information of one or more indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html

An optional descriptor that further describes the status operation, i.e limiting it to certain indices

Returns information and statistics on terms in the fields of a particular document as stored in the index. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-termvectors.html

Multi termvectors API allows to get multiple termvectors based on an index, type and id. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html

The type used to infer the default index and typename The descriptor describing the multi termvectors operation

The suggest feature suggests similar looking terms based on a provided text by using a suggester. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters.html

The type used to strongly type parts of the suggest operation The suggesters to use this operation (can be multiple)

Deletes a registered scroll request on the cluster http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html

Specify the scroll id as well as request specific configuration

Check if a document exists without returning its contents http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

The type used to infer the default index and typename Describe what document we are looking for

Before any snapshot or restore operation can be performed a snapshot repository should be registered in Elasticsearch. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories

The name for the repository describe what the repository looks like

Delete a repository, if you have ongoing restore operations be sure to delete the indices being restored into first. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories

The name of the repository Optionaly provide the delete operation with more details>

A repository can contain multiple snapshots of the same cluster. Snapshot are identified by unique names within the cluster. /// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot

The name of the repository we want to create a snapshot in The name of the snapshot Optionally provide more details about the snapshot operation

Delete a snapshot http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot

The repository name under which the snapshot we want to delete lives The name of the snapshot that we want to delete Optionally further describe the delete snapshot operation

Gets information about one or more snapshots http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot

The repository name under which the snapshots live The names of the snapshots we want information from (can be _all or wildcards) Optionally further describe the get snapshot operation

Restore a snapshot http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_restore

The repository name that holds our snapshot The name of the snapshot that we want to restore Optionally further describe the restore operation

Allows to update cluster wide specific settings. Settings updated can either be persistent (applied cross restarts) or transient (will not survive a full cluster restart). http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html

Gets cluster wide specific settings. Settings updated can either be persistent (applied cross restarts) or transient (will not survive a full cluster restart). http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html

Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.

Executes a HEAD request to the cluster to determine whether it's up or not.

Perform any request you want over the configured IConnection synchronously while taking advantage of the cluster failover.

The type representing the response JSON the HTTP Method to use The path of the the url that you would like to hit The body of the request, string and byte[] are posted as is other types will be serialized to JSON Optionally configure request specific timeouts, headers An ElasticsearchResponse of T where T represents the JSON response body

Perform any request you want over the configured IConnection asynchronously while taking advantage of the cluster failover.

The type representing the response JSON the HTTP Method to use The path of the the url that you would like to hit The body of the request, string and byte[] are posted as is other types will be serialized to JSON Optionally configure request specific timeouts, headers A task of ElasticsearchResponse of T where T represents the JSON response body

Perform any request you want over the configured IConnection while taking advantage of the cluster failover.

Perform any request you want over the configured IConnection asynchronously while taking advantage of the cluster failover.

The type representing the response JSON the HTTP Method to use The path of the the url that you would like to hit The body of the request, string and byte[] are posted as is other types will be serialized to JSON Optionally configure request specific timeouts, headers A task of ElasticsearchResponse of T where T represents the JSON response body

Because the nodes.hot_threads endpoint returns plain text instead of JSON, we have to manually parse the response text into a typed response object.

Instantiate a new strongly typed connection to elasticsearch

An optional settings object telling the client how and where to connect to. Defaults to a static single node connection pool to http://localhost:9200 It's recommended to pass an explicit 'new ConnectionSettings()' instance Optionally provide a different connection handler, defaults to http using HttpWebRequest Optionally provide a custom serializer responsible for taking a stream and turning into T The transport coordinates requests between the client and the connection pool and the connection

Deserialize an object

The type you want to deserialize too The stream to deserialize off

Deserialize to type T bypassing checks for custom deserialization state and or BaseResponse return types.

_msearch needs a specialized json format in the body

descriptor for SnapshotGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html

Explicit operation timeout for connection to master node

descriptor for MtermvectorsGet

            http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html

Provides a base for descriptors that need to describe a path in the form of

            /{index}/{type}