Tirexs v0.8.15 Tirexs.Resources.APIs

This module provides a set of API helpers. Helpers are useful for buiding an URN part of particular request. Most commonly the result of this would be used for dealing directly with variety of available Tirexs.HTTP functions.

Examples:

iex> APIs._refresh({ [force: true] })
"_refresh?force=true"

iex> APIs._refresh(["bear_test", "duck_test"], { [force: false] })
"bear_test,duck_test/_refresh?force=false"

iex> APIs._field_mapping(["bear_test", "duck_test"], "message", {[ ignore_unavailable: true ]})
"bear_test,duck_test/_mapping/message/field?ignore_unavailable=true"

iex> APIs._field_mapping("_all", "tw*", ["*.id", "*.text"])
"_all/_mapping/tw*/field/*.id,*.text"

NOTICE: All of helpers have the same interface, behaviour and almost don’t care about the details. It means, you have a chance to create a complety unsupported API call.

For instance:

iex> APIs._refresh(["bear_test", "duck_test"], ["a", "b"], {[ human: true ]})
"bear_test,duck_test/_refresh/a,b?human=true"

A Tirexs.Resources.urn/x is responsible for concatenation parts all together.

Feature requests

Feature requests are welcome and should be discussed. But take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible (from CONTRIBUTING.md).

Summary

Functions

_alias()

See Tirexs.Resources.Indices._alias/0

_alias(a)

See Tirexs.Resources.Indices._alias/1

_alias(a, b)

See Tirexs.Resources.Indices._alias/2

_alias(a, b, c)

See Tirexs.Resources.Indices._alias/3

_aliases()

See Tirexs.Resources.Indices._aliases/0

_aliases(a)

See Tirexs.Resources.Indices._aliases/1

_aliases(a, b)

See Tirexs.Resources.Indices._aliases/2

_aliases(a, b, c)

See Tirexs.Resources.Indices._aliases/3

_all_mapping()

See Tirexs.Resources.Indices._all_mapping/0

_analyze()

See Tirexs.Resources.Indices._analyze/0

_analyze(a)

See Tirexs.Resources.Indices._analyze/1

_analyze(a, b)

See Tirexs.Resources.Indices._analyze/2

_analyze(a, b, c)

See Tirexs.Resources.Indices._analyze/3

_bulk()

See Tirexs.Resources.Document._bulk/0

_bulk(a)

See Tirexs.Resources.Document._bulk/1

_bulk(a, b)

See Tirexs.Resources.Document._bulk/2

_bulk(a, b, c)

See Tirexs.Resources.Document._bulk/3

_cache_clear()

See Tirexs.Resources.Indices._cache_clear/0

_cache_clear(a)

See Tirexs.Resources.Indices._cache_clear/1

_cache_clear(a, b, c)

See Tirexs.Resources.Indices._cache_clear/3

_close()

See Tirexs.Resources.Indices._close/0

_close(a)

See Tirexs.Resources.Indices._close/1

_close(a, b)

See Tirexs.Resources.Indices._close/2

_close(a, b, c)

See Tirexs.Resources.Indices._close/3

_count()

See Tirexs.Resources.Search._count/0

_count(a)

See Tirexs.Resources.Search._count/1

_count(a, b)

See Tirexs.Resources.Search._count/2

_count(a, b, c)

See Tirexs.Resources.Search._count/3

_explain(a)

See Tirexs.Resources.Search._explain/1

_explain(a, b)

See Tirexs.Resources.Search._explain/2

_explain(a, b, c)

See Tirexs.Resources.Search._explain/3

_explain(a, b, c, d)

See Tirexs.Resources.Search._explain/4

_field_mapping(a)

See Tirexs.Resources.Indices._field_mapping/1

_field_mapping(a, b)

See Tirexs.Resources.Indices._field_mapping/2

_field_mapping(a, b, c, d)

See Tirexs.Resources.Indices._field_mapping/4

_field_stats()

See Tirexs.Resources.Search._field_stats/0

_field_stats(a)

See Tirexs.Resources.Search._field_stats/1

_field_stats(a, b)

See Tirexs.Resources.Search._field_stats/2

_flush()

See Tirexs.Resources.Indices._flush/0

_flush(a)

See Tirexs.Resources.Indices._flush/1

_flush(a, b)

See Tirexs.Resources.Indices._flush/2

_flush(a, b, c)

See Tirexs.Resources.Indices._flush/3

_forcemerge()

See Tirexs.Resources.Indices._forcemerge/0

_forcemerge(a)

See Tirexs.Resources.Indices._forcemerge/1

_forcemerge(a, b)

See Tirexs.Resources.Indices._forcemerge/2

_forcemerge(a, b, c)

See Tirexs.Resources.Indices._forcemerge/3

_mapping()

See Tirexs.Resources.Indices._mapping/0

_mapping(a)

See Tirexs.Resources.Indices._mapping/1

_mapping(a, b)

See Tirexs.Resources.Indices._mapping/2

_mapping(a, b, c)

See Tirexs.Resources.Indices._mapping/3

_mget()

See Tirexs.Resources.Document._mget/0

_mget(a)

See Tirexs.Resources.Document._mget/1

_mget(a, b)

See Tirexs.Resources.Document._mget/2

_mget(a, b, c)

See Tirexs.Resources.Document._mget/3

_open()

See Tirexs.Resources.Indices._open/0

_open(a)

See Tirexs.Resources.Indices._open/1

_open(a, b)

See Tirexs.Resources.Indices._open/2

_open(a, b, c)

See Tirexs.Resources.Indices._open/3

_percolate(a)

See Tirexs.Resources.Search._percolate/1

_percolate(a, b)

See Tirexs.Resources.Search._percolate/2

_percolate(a, b, c)

See Tirexs.Resources.Search._percolate/3

_percolate(a, b, c, d)

See Tirexs.Resources.Search._percolate/4

_percolate_count(a)

See Tirexs.Resources.Search._percolate_count/1

_percolate_count(a, b)

See Tirexs.Resources.Search._percolate_count/2

_percolate_count(a, b, c)

See Tirexs.Resources.Search._percolate_count/3

_percolate_count(a, b, c, d)

See Tirexs.Resources.Search._percolate_count/4

_recovery()

See Tirexs.Resources.Indices._recovery/0

_recovery(a)

See Tirexs.Resources.Indices._recovery/1

_recovery(a, b)

See Tirexs.Resources.Indices._recovery/2

_recovery(a, b, c)

See Tirexs.Resources.Indices._recovery/3

_refresh()

See Tirexs.Resources.Indices._refresh/0

_refresh(a)

See Tirexs.Resources.Indices._refresh/1

_refresh(a, b)

See Tirexs.Resources.Indices._refresh/2

_refresh(a, b, c)

See Tirexs.Resources.Indices._refresh/3

_search()

See Tirexs.Resources.Search._search/0

_search(a)

See Tirexs.Resources.Search._search/1

_search(a, b)

See Tirexs.Resources.Search._search/2

_search(a, b, c)

See Tirexs.Resources.Search._search/3

_search_exists()

See Tirexs.Resources.Search._search_exists/0

_search_exists(a)

See Tirexs.Resources.Search._search_exists/1

_search_exists(a, b)

See Tirexs.Resources.Search._search_exists/2

_search_exists(a, b, c)

See Tirexs.Resources.Search._search_exists/3

_search_scroll()

See Tirexs.Resources.Search._search_scroll/0

_search_scroll(a)

See Tirexs.Resources.Search._search_scroll/1

_search_scroll_all()

See Tirexs.Resources.Search._search_scroll_all/0

_search_shards(a)

See Tirexs.Resources.Search._search_shards/1

_search_shards(a, b)

See Tirexs.Resources.Search._search_shards/2

_search_shards(a, b, c)

See Tirexs.Resources.Search._search_shards/3

_segments()

See Tirexs.Resources.Indices._segments/0

_segments(a)

See Tirexs.Resources.Indices._segments/1

_segments(a, b)

See Tirexs.Resources.Indices._segments/2

_segments(a, b, c)

See Tirexs.Resources.Indices._segments/3

_settings()

See Tirexs.Resources.Indices._settings/0

_settings(a)

See Tirexs.Resources.Indices._settings/1

_settings(a, b)

See Tirexs.Resources.Indices._settings/2

_settings(a, b, c)

See Tirexs.Resources.Indices._settings/3

_shard_stores()

See Tirexs.Resources.Indices._shard_stores/0

_shard_stores(a)

See Tirexs.Resources.Indices._shard_stores/1

_shard_stores(a, b)

See Tirexs.Resources.Indices._shard_stores/2

_shard_stores(a, b, c)

See Tirexs.Resources.Indices._shard_stores/3

_source(a)

See Tirexs.Resources.Document._source/1

_source(a, b)

See Tirexs.Resources.Document._source/2

_source(a, b, c)

See Tirexs.Resources.Document._source/3

_source(a, b, c, d)

See Tirexs.Resources.Document._source/4

_stats()

See Tirexs.Resources.Indices._stats/0

_stats(a)

See Tirexs.Resources.Indices._stats/1

_stats(a, b)

See Tirexs.Resources.Indices._stats/2

_stats(a, b, c)

See Tirexs.Resources.Indices._stats/3

_template()

See Tirexs.Resources.Indices._template/0

_template(a)

See Tirexs.Resources.Indices._template/1

_template(a, b)

See Tirexs.Resources.Indices._template/2

_template(a, b, c)

See Tirexs.Resources.Indices._template/3

_update(a)

See Tirexs.Resources.Document._update/1

_update(a, b)

See Tirexs.Resources.Document._update/2

_update(a, b, c)

See Tirexs.Resources.Document._update/3

_update(a, b, c, d)

See Tirexs.Resources.Document._update/4

_upgrade()

See Tirexs.Resources.Indices._upgrade/0

_upgrade(a)

See Tirexs.Resources.Indices._upgrade/1

_upgrade(a, b)

See Tirexs.Resources.Indices._upgrade/2

_upgrade(a, b, c)

See Tirexs.Resources.Indices._upgrade/3

_validate_query()

See Tirexs.Resources.Search._validate_query/0

_validate_query(a)

See Tirexs.Resources.Search._validate_query/1

_validate_query(a, b)

See Tirexs.Resources.Search._validate_query/2

_validate_query(a, b, c)

See Tirexs.Resources.Search._validate_query/3

_warmer()

See Tirexs.Resources.Indices._warmer/0

_warmer(a)

See Tirexs.Resources.Indices._warmer/1

_warmer(a, b)

See Tirexs.Resources.Indices._warmer/2

_warmer(a, b, c)

See Tirexs.Resources.Indices._warmer/3

doc(a)

See Tirexs.Resources.Document.doc/1

doc(a, b)

See Tirexs.Resources.Document.doc/2

doc(a, b, c)

See Tirexs.Resources.Document.doc/3

doc(a, b, c, d)

See Tirexs.Resources.Document.doc/4

index(a)

See Tirexs.Resources.Document.index/1

index(a, b)

See Tirexs.Resources.Document.index/2

index(a, b, c)

See Tirexs.Resources.Document.index/3

index(a, b, c, d)

See Tirexs.Resources.Document.index/4

percolator(a, b)

See Tirexs.Resources.Search.percolator/2

Functions

_alias()

See Tirexs.Resources.Indices._alias/0.

_alias(a)

See Tirexs.Resources.Indices._alias/1.

_alias(a, b)

See Tirexs.Resources.Indices._alias/2.

_alias(a, b, c)

See Tirexs.Resources.Indices._alias/3.

_aliases()

See Tirexs.Resources.Indices._aliases/0.

_aliases(a)

See Tirexs.Resources.Indices._aliases/1.

_aliases(a, b)

See Tirexs.Resources.Indices._aliases/2.

_aliases(a, b, c)

See Tirexs.Resources.Indices._aliases/3.

_all_mapping()

See Tirexs.Resources.Indices._all_mapping/0.

_analyze()

See Tirexs.Resources.Indices._analyze/0.

_analyze(a)

See Tirexs.Resources.Indices._analyze/1.

_analyze(a, b)

See Tirexs.Resources.Indices._analyze/2.

_analyze(a, b, c)

See Tirexs.Resources.Indices._analyze/3.

_bulk()

See Tirexs.Resources.Document._bulk/0.

_bulk(a)

See Tirexs.Resources.Document._bulk/1.

_bulk(a, b)

See Tirexs.Resources.Document._bulk/2.

_bulk(a, b, c)

See Tirexs.Resources.Document._bulk/3.

_cache_clear()

See Tirexs.Resources.Indices._cache_clear/0.

_cache_clear(a)

See Tirexs.Resources.Indices._cache_clear/1.

_cache_clear(a, b, c)

See Tirexs.Resources.Indices._cache_clear/3.

_close()

See Tirexs.Resources.Indices._close/0.

_close(a)

See Tirexs.Resources.Indices._close/1.

_close(a, b)

See Tirexs.Resources.Indices._close/2.

_close(a, b, c)

See Tirexs.Resources.Indices._close/3.

_count()

See Tirexs.Resources.Search._count/0.

_count(a)

See Tirexs.Resources.Search._count/1.

_count(a, b)

See Tirexs.Resources.Search._count/2.

_count(a, b, c)

See Tirexs.Resources.Search._count/3.

_explain(a)

See Tirexs.Resources.Search._explain/1.

_explain(a, b)

See Tirexs.Resources.Search._explain/2.

_explain(a, b, c)

See Tirexs.Resources.Search._explain/3.

_explain(a, b, c, d)

See Tirexs.Resources.Search._explain/4.

_field_mapping(a)

See Tirexs.Resources.Indices._field_mapping/1.

_field_mapping(a, b)

See Tirexs.Resources.Indices._field_mapping/2.

_field_mapping(a, b, c, d)

See Tirexs.Resources.Indices._field_mapping/4.

_field_stats()

See Tirexs.Resources.Search._field_stats/0.

_field_stats(a)

See Tirexs.Resources.Search._field_stats/1.

_field_stats(a, b)

See Tirexs.Resources.Search._field_stats/2.

_flush()

See Tirexs.Resources.Indices._flush/0.

_flush(a)

See Tirexs.Resources.Indices._flush/1.

_flush(a, b)

See Tirexs.Resources.Indices._flush/2.

_flush(a, b, c)

See Tirexs.Resources.Indices._flush/3.

_forcemerge()

See Tirexs.Resources.Indices._forcemerge/0.

_forcemerge(a)

See Tirexs.Resources.Indices._forcemerge/1.

_forcemerge(a, b)

See Tirexs.Resources.Indices._forcemerge/2.

_forcemerge(a, b, c)

See Tirexs.Resources.Indices._forcemerge/3.

_mapping()

See Tirexs.Resources.Indices._mapping/0.

_mapping(a)

See Tirexs.Resources.Indices._mapping/1.

_mapping(a, b)

See Tirexs.Resources.Indices._mapping/2.

_mapping(a, b, c)

See Tirexs.Resources.Indices._mapping/3.

_mget()

See Tirexs.Resources.Document._mget/0.

_mget(a)

See Tirexs.Resources.Document._mget/1.

_mget(a, b)

See Tirexs.Resources.Document._mget/2.

_mget(a, b, c)

See Tirexs.Resources.Document._mget/3.

_open()

See Tirexs.Resources.Indices._open/0.

_open(a)

See Tirexs.Resources.Indices._open/1.

_open(a, b)

See Tirexs.Resources.Indices._open/2.

_open(a, b, c)

See Tirexs.Resources.Indices._open/3.

_percolate(a)

See Tirexs.Resources.Search._percolate/1.

_percolate(a, b)

See Tirexs.Resources.Search._percolate/2.

_percolate(a, b, c)

See Tirexs.Resources.Search._percolate/3.

_percolate(a, b, c, d)

See Tirexs.Resources.Search._percolate/4.

_percolate_count(a)

See Tirexs.Resources.Search._percolate_count/1.

_percolate_count(a, b)

See Tirexs.Resources.Search._percolate_count/2.

_percolate_count(a, b, c)

See Tirexs.Resources.Search._percolate_count/3.

_percolate_count(a, b, c, d)

See Tirexs.Resources.Search._percolate_count/4.

_recovery()

See Tirexs.Resources.Indices._recovery/0.

_recovery(a)

See Tirexs.Resources.Indices._recovery/1.

_recovery(a, b)

See Tirexs.Resources.Indices._recovery/2.

_recovery(a, b, c)

See Tirexs.Resources.Indices._recovery/3.

_refresh()

See Tirexs.Resources.Indices._refresh/0.

_refresh(a)

See Tirexs.Resources.Indices._refresh/1.

_refresh(a, b)

See Tirexs.Resources.Indices._refresh/2.

_refresh(a, b, c)

See Tirexs.Resources.Indices._refresh/3.

_search()

See Tirexs.Resources.Search._search/0.

_search(a)

See Tirexs.Resources.Search._search/1.

_search(a, b)

See Tirexs.Resources.Search._search/2.

_search(a, b, c)

See Tirexs.Resources.Search._search/3.

_search_exists()

See Tirexs.Resources.Search._search_exists/0.

_search_exists(a)

See Tirexs.Resources.Search._search_exists/1.

_search_exists(a, b)

See Tirexs.Resources.Search._search_exists/2.

_search_exists(a, b, c)

See Tirexs.Resources.Search._search_exists/3.

_search_scroll()

See Tirexs.Resources.Search._search_scroll/0.

_search_scroll(a)

See Tirexs.Resources.Search._search_scroll/1.

_search_scroll_all()

See Tirexs.Resources.Search._search_scroll_all/0.

_search_shards(a)

See Tirexs.Resources.Search._search_shards/1.

_search_shards(a, b)

See Tirexs.Resources.Search._search_shards/2.

_search_shards(a, b, c)

See Tirexs.Resources.Search._search_shards/3.

_segments()

See Tirexs.Resources.Indices._segments/0.

_segments(a)

See Tirexs.Resources.Indices._segments/1.

_segments(a, b)

See Tirexs.Resources.Indices._segments/2.

_segments(a, b, c)

See Tirexs.Resources.Indices._segments/3.

_settings()

See Tirexs.Resources.Indices._settings/0.

_settings(a)

See Tirexs.Resources.Indices._settings/1.

_settings(a, b)

See Tirexs.Resources.Indices._settings/2.

_settings(a, b, c)

See Tirexs.Resources.Indices._settings/3.

_shard_stores()

See Tirexs.Resources.Indices._shard_stores/0.

_shard_stores(a)

See Tirexs.Resources.Indices._shard_stores/1.

_shard_stores(a, b)

See Tirexs.Resources.Indices._shard_stores/2.

_shard_stores(a, b, c)

See Tirexs.Resources.Indices._shard_stores/3.

_source(a)

See Tirexs.Resources.Document._source/1.

_source(a, b)

See Tirexs.Resources.Document._source/2.

_source(a, b, c)

See Tirexs.Resources.Document._source/3.

_source(a, b, c, d)

See Tirexs.Resources.Document._source/4.

_stats()

See Tirexs.Resources.Indices._stats/0.

_stats(a)

See Tirexs.Resources.Indices._stats/1.

_stats(a, b)

See Tirexs.Resources.Indices._stats/2.

_stats(a, b, c)

See Tirexs.Resources.Indices._stats/3.

_template()

See Tirexs.Resources.Indices._template/0.

_template(a)

See Tirexs.Resources.Indices._template/1.

_template(a, b)

See Tirexs.Resources.Indices._template/2.

_template(a, b, c)

See Tirexs.Resources.Indices._template/3.

_update(a)

See Tirexs.Resources.Document._update/1.

_update(a, b)

See Tirexs.Resources.Document._update/2.

_update(a, b, c)

See Tirexs.Resources.Document._update/3.

_update(a, b, c, d)

See Tirexs.Resources.Document._update/4.

_upgrade()

See Tirexs.Resources.Indices._upgrade/0.

_upgrade(a)

See Tirexs.Resources.Indices._upgrade/1.

_upgrade(a, b)

See Tirexs.Resources.Indices._upgrade/2.

_upgrade(a, b, c)

See Tirexs.Resources.Indices._upgrade/3.

_validate_query()

See Tirexs.Resources.Search._validate_query/0.

_validate_query(a)

See Tirexs.Resources.Search._validate_query/1.

_validate_query(a, b)

See Tirexs.Resources.Search._validate_query/2.

_validate_query(a, b, c)

See Tirexs.Resources.Search._validate_query/3.

_warmer()

See Tirexs.Resources.Indices._warmer/0.

_warmer(a)

See Tirexs.Resources.Indices._warmer/1.

_warmer(a, b)

See Tirexs.Resources.Indices._warmer/2.

_warmer(a, b, c)

See Tirexs.Resources.Indices._warmer/3.

doc(a)

See Tirexs.Resources.Document.doc/1.

doc(a, b)

See Tirexs.Resources.Document.doc/2.

doc(a, b, c)

See Tirexs.Resources.Document.doc/3.

doc(a, b, c, d)

See Tirexs.Resources.Document.doc/4.

index(a)

See Tirexs.Resources.Document.index/1.

index(a, b)

See Tirexs.Resources.Document.index/2.

index(a, b, c)

See Tirexs.Resources.Document.index/3.

index(a, b, c, d)

See Tirexs.Resources.Document.index/4.

percolator(a, b)

See Tirexs.Resources.Search.percolator/2.