module Elastics::ApiStubs
Public Class Methods
########## Elastics.analyze_index
##########
API Name: Analyze API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html
-
GET
-
“/<<index>>/_analyze”
Usage: Elastics.analyze_index
:index => nil
Notice: You can pass the text to analyze as the :data variable (or the param :text). You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 1021 def self.analyze_index(*vars) ## this is a stub, used for reference super end
########## Elastics.cat
##########
API Name: Cat API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
cat:
-
GET
-
“/”
Usage: Elastics.cat
Notice: You must pass the :path variable or you can pass it as a simple string argument: Elastics.cat
('/path')
# File lib/elastics/api_stubs.rb, line 1435 def self.cat(*vars) ## this is a stub, used for reference super end
########## Elastics.close_index
##########
API Name: Open/Close Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
-
POST
-
“/<<index>>/_close”
Usage: Elastics.close_index
:index => nil
# File lib/elastics/api_stubs.rb, line 688 def self.close_index(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_health
##########
API Name: Health API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
-
GET
-
“/_cluster/health/<<index>>”
Usage: Elastics.cluster_health
:index => nil
Notice: You can pass the params as the :params variable.
# File lib/elastics/api_stubs.rb, line 1459 def self.cluster_health(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_nodes_hot_threads
##########
API Name: Nodes Hot Threads API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
-
GET
-
“/_nodes/<<nodes= ~ >>/hot_threads”
Usage: Elastics.cluster_nodes_hot_threads
:nodes => nil
# File lib/elastics/api_stubs.rb, line 1669 def self.cluster_nodes_hot_threads(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_nodes_info
##########
API Name: Nodes Info API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
-
GET
-
“/_nodes/<<nodes= ~ >>/<<info= ~ >>”
Usage: Elastics.cluster_nodes_info
:nodes => nil,
:info => nil
Notice: This template uses the _nodes shortcut.
# File lib/elastics/api_stubs.rb, line 1647 def self.cluster_nodes_info(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_nodes_stats
##########
API Name: Nodes Stats API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
-
GET
-
“/_nodes/<<nodes= ~ >>/stats/<<stats= ~ >>”
Usage: Elastics.cluster_nodes_stats
:nodes => nil,
:stats => nil
Notice: You can pass the params as the :params variable. You must pass the data structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 1622 def self.cluster_nodes_stats(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_pending_tasks
##########
API Name: Pending Cluster Tasks
API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
-
GET
-
“/_cluster/pending_tasks”
Usage: Elastics.cluster_pending_tasks
Notice: You can pass the params as the :params variable.
# File lib/elastics/api_stubs.rb, line 1530 def self.cluster_pending_tasks(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_reroute
##########
API Name: Cluster Reroute API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
-
POST
-
“/_cluster/reroute”
Usage: Elastics.cluster_reroute
Notice: You must pass the data structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 1553 def self.cluster_reroute(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_state
##########
API Name: State API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
-
GET
-
“/_cluster/state/<<metrics= _all >>/<<index>>”
Usage: Elastics.cluster_state
:metrics => “_all”,
:index => nil
Notice: You can pass the metrics as the :metrics variable.
# File lib/elastics/api_stubs.rb, line 1484 def self.cluster_state(*vars) ## this is a stub, used for reference super end
########## Elastics.cluster_stats
##########
API Name: Stats API URL: www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
-
GET
-
“/_cluster/stats”
Usage: Elastics.cluster_stats
Notice: You can pass the params as the :params variable.
# File lib/elastics/api_stubs.rb, line 1507 def self.cluster_stats(*vars) ## this is a stub, used for reference super end
########## Elastics.count
##########
API Name: Search Shards API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
count:
-
GET
-
“/<<index>>/<<type>>/_count”
Usage: Elastics.count
:index => nil,
:type => nil
Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 335 def self.count(*vars) ## this is a stub, used for reference super end
########## Elastics.delete
##########
API Name: Delete API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
delete:
-
DELETE
-
“/<<index>>/<<type>>/<<id>>”
Usage: Elastics.delete
:id => id, # required
:type => nil, :index => nil
Notice: You must pass the :data variable.
# File lib/elastics/api_stubs.rb, line 128 def self.delete(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_index
##########
API Name: Delete Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
-
DELETE
-
“/<<index>>”
Usage: Elastics.delete_index
:index => nil
# File lib/elastics/api_stubs.rb, line 620 def self.delete_index(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_index_alias
##########
API Name: Index Aliases API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-
DELETE
-
“/<<index>>/_alias/<<alias>>”
Usage: Elastics.delete_index_alias
:alias => alias, # required
:index => nil
# File lib/elastics/api_stubs.rb, line 901 def self.delete_index_alias(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_index_mapping
##########
API Name: Delete Mappings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html
-
DELETE
-
“/<<index>>/<<type>>”
Usage: Elastics.delete_index_mapping
:index => nil,
:type => nil
# File lib/elastics/api_stubs.rb, line 831 def self.delete_index_mapping(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_index_template
##########
API Name: Index Templates
API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
-
DELETE
-
“/_template/<<template>>”
Usage: Elastics.delete_index_template
:template => template # required
# File lib/elastics/api_stubs.rb, line 1043 def self.delete_index_template(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_index_warmer
##########
API Name: Warmers API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
-
DELETE
-
“/<<index>>/_warmer/<<warmer>>”
Usage: Elastics.delete_index_warmer
:warmer => warmer, # required
:index => nil
# File lib/elastics/api_stubs.rb, line 1134 def self.delete_index_warmer(*vars) ## this is a stub, used for reference super end
########## Elastics.delete_percolator
##########
API Name: Percolator API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
-
DELETE
-
“/<<index>>/.percolator/<<id>>”
Usage: Elastics.delete_percolator
:id => id, # required
:index => nil
# File lib/elastics/api_stubs.rb, line 436 def self.delete_percolator(*vars) ## this is a stub, used for reference super end
########## Elastics.explain
##########
API Name: Validate API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
explain:
-
GET
-
“/<<index>>/<<type>>/<<id= ~ >>/_explain”
Usage: Elastics.explain
:index => nil,
:type => nil, :id => nil
Notice: You must pass the query to explain as the :data variable. You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 413 def self.explain(*vars) ## this is a stub, used for reference super end
########## Elastics.flush_index
##########
API Name: Flush API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
-
POST
-
“/<<index>>/_flush”
Usage: Elastics.flush_index
:index => nil
Notice: You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 1318 def self.flush_index(*vars) ## this is a stub, used for reference super end
########## Elastics.get
##########
API Name: Get API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
get:
-
GET
-
“/<<index>>/<<type>>/<<id>>”
Usage: Elastics.get
:id => id, # required
:type => nil, :index => nil
# File lib/elastics/api_stubs.rb, line 78 def self.get(*vars) ## this is a stub, used for reference super end
########## Elastics.get_cluster_settings
##########
API Name: Cluster Update Settings API URL: www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings
-
GET
-
“/_cluster/settings”
Usage: Elastics.get_cluster_settings
# File lib/elastics/api_stubs.rb, line 1574 def self.get_cluster_settings(*vars) ## this is a stub, used for reference super end
########## Elastics.get_field_mapping
##########
API Name: Get Field Mappings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
-
GET
-
“/<<index>>/_mapping/<<type>>/field/<<field>>”
Usage: Elastics.get_field_mapping
:field => field, # required
:type => nil, :index => nil
# File lib/elastics/api_stubs.rb, line 784 def self.get_field_mapping(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index
##########
API Name: Get Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
-
GET
-
“/<<index>>/<<features= ~ >>”
Usage: Elastics.get_index
:index => nil,
:features => nil
# File lib/elastics/api_stubs.rb, line 643 def self.get_index(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_alias
##########
API Name: Index Aliases API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-
GET
-
“/<<index>>/_alias/<<alias= '*' >>”
Usage: Elastics.get_index_alias
:index => nil,
:alias => "*"
# File lib/elastics/api_stubs.rb, line 924 def self.get_index_alias(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_aliases
##########
API Name: Index Aliases API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-
GET
-
“/<<index>>/_aliases”
Usage: Elastics.get_index_aliases
:index => nil
# File lib/elastics/api_stubs.rb, line 853 def self.get_index_aliases(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_mapping
##########
API Name: Get Mappings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html
-
GET
-
“/<<index>>/_mapping/<<type>>”
Usage: Elastics.get_index_mapping
:index => nil,
:type => nil
# File lib/elastics/api_stubs.rb, line 760 def self.get_index_mapping(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_settings
##########
API Name: Get Indices
Settings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
-
GET
-
“/<<index>>/_settings”
Usage: Elastics.get_index_settings
:index => nil
# File lib/elastics/api_stubs.rb, line 996 def self.get_index_settings(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_template
##########
API Name: Index Templates
API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
-
GET
-
“/_template/<<template= ~ >>”
Usage: Elastics.get_index_template
:template => nil
# File lib/elastics/api_stubs.rb, line 1065 def self.get_index_template(*vars) ## this is a stub, used for reference super end
########## Elastics.get_index_warmer
##########
API Name: Warmers API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
-
GET
-
“/<<index>>/_warmer/<<warmer= ~ >>”
Usage: Elastics.get_index_warmer
:index => nil,
:warmer => nil
# File lib/elastics/api_stubs.rb, line 1183 def self.get_index_warmer(*vars) ## this is a stub, used for reference super end
########## Elastics.get_source
##########
API Name: Get API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
-
GET
-
“/<<index>>/<<type>>/<<id>>/_source”
Usage: Elastics.get_source
:id => id, # required
:type => nil, :index => nil
# File lib/elastics/api_stubs.rb, line 102 def self.get_source(*vars) ## this is a stub, used for reference super end
########## Elastics.index_clearcache
##########
API Name: Recovery API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
-
POST
-
“/<<index>>/_cache/clear”
Usage: Elastics.index_clearcache
:index => nil
# File lib/elastics/api_stubs.rb, line 1294 def self.index_clearcache(*vars) ## this is a stub, used for reference super end
########## Elastics.index_recovery
##########
API Name: Recovery API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
-
GET
-
“/<<index>>/_recovery”
Usage: Elastics.index_recovery
:index => nil
# File lib/elastics/api_stubs.rb, line 1272 def self.index_recovery(*vars) ## this is a stub, used for reference super end
########## Elastics.index_segments
##########
API Name: Segments API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
-
GET
-
“/<<index>>/_segments”
Usage: Elastics.index_segments
:index => nil
# File lib/elastics/api_stubs.rb, line 1250 def self.index_segments(*vars) ## this is a stub, used for reference super end
########## Elastics.index_stats
##########
API Name: Stats API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
-
GET
-
“/<<index>>/_stats/<<stats= ~ >>”
Usage: Elastics.index_stats
:index => nil,
:stats => nil
# File lib/elastics/api_stubs.rb, line 1228 def self.index_stats(*vars) ## this is a stub, used for reference super end
########## Elastics.index_status
##########
API Name: Status API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
-
GET
-
“/<<index>>/_status”
Usage: Elastics.index_status
:index => nil
# File lib/elastics/api_stubs.rb, line 1205 def self.index_status(*vars) ## this is a stub, used for reference super end
########## Elastics.index_template_exists
##########
API Name: Index Templates
API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
-
HEAD
-
“/_template/<<template>>”
Usage: Elastics.index_template_exists
:template => template # required
# File lib/elastics/api_stubs.rb, line 1087 def self.index_template_exists(*vars) ## this is a stub, used for reference super end
########## Elastics.indices_exists
##########
API Name: Indices
Exists API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
-
HEAD
-
“/<<index>>”
Usage: Elastics.indices_exists
:index => nil
# File lib/elastics/api_stubs.rb, line 665 def self.indices_exists(*vars) ## this is a stub, used for reference super end
########## Elastics.match_all
##########
API Name: API URL:
-
GET
-
“/<<index>>/<<type>>/_search”
-
query:
match_all: {}
Usage: Elastics.match_all
:index => nil,
:type => nil
Notice: Not a real API method, but handy.
# File lib/elastics/api_stubs.rb, line 1696 def self.match_all(*vars) ## this is a stub, used for reference super end
########## Elastics.more_like_this
##########
API Name: More Like This API URL: www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html
-
GET
-
“/<<index>>/<<type>>/<<id>>/_mlt”
Usage: Elastics.more_like_this
:id => id, # required
:type => nil, :index => nil
Notice: You can pass the search API as :data variable.
# File lib/elastics/api_stubs.rb, line 537 def self.more_like_this(*vars) ## this is a stub, used for reference super end
########## Elastics.multi_get_docs
##########
API Name: Multi Get API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
-
GET
-
“/<<index>>/<<type>>/_mget”
-
docs: “<< docs >>”
Usage: Elastics.multi_get_docs
:docs => docs, # required
:type => nil, :index => nil
Notice: You must pass the :docs array.
# File lib/elastics/api_stubs.rb, line 210 def self.multi_get_docs(*vars) ## this is a stub, used for reference super end
########## Elastics.multi_get_ids
##########
API Name: Multi Get API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
-
GET
-
“/<<index>>/<<type>>/_mget”
-
ids: “<< ids >>”
Usage: Elastics.multi_get_ids
:ids => ids, # required
:type => nil, :index => nil
Notice: You must pass the :ids array.
# File lib/elastics/api_stubs.rb, line 182 def self.multi_get_ids(*vars) ## this is a stub, used for reference super end
########## Elastics.multi_termvectors
##########
API Name: Multi Termvectors API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
-
POST
-
“/<<index>>/<<type>>/_mtermvectors”
-
docs: “<<docs= ~ >>”
Usage: Elastics.multi_termvectors
:index => nil,
:type => nil, :docs => nil
Notice: You must pass the docs array as the :docs variable or use the :data variable for the simplified request.
# File lib/elastics/api_stubs.rb, line 285 def self.multi_termvectors(*vars) ## this is a stub, used for reference super end
########## Elastics.open_index
##########
API Name: Open/Close Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
-
POST
-
“/<<index>>/_open”
Usage: Elastics.open_index
:index => nil
# File lib/elastics/api_stubs.rb, line 710 def self.open_index(*vars) ## this is a stub, used for reference super end
########## Elastics.optimize_index
##########
API Name: Optimize API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-optimize.html
-
POST
-
“/<<index>>/_optimize”
Usage: Elastics.optimize_index
:index => nil
Notice: You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 1388 def self.optimize_index(*vars) ## this is a stub, used for reference super end
########## Elastics.percolate
##########
API Name: Percolator API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
percolate:
-
GET
-
“/<<index>>/<<type>>/_percolate”
Usage: Elastics.percolate
:index => nil,
:type => nil
Notice: You must pass the the document (and additional queries) as :data variable.
# File lib/elastics/api_stubs.rb, line 461 def self.percolate(*vars) ## this is a stub, used for reference super end
########## Elastics.percolate_count
##########
API Name: Percolator API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
-
GET
-
“/<<index>>/<<type>>/_percolate/count”
Usage: Elastics.percolate_count
:index => nil,
:type => nil
Notice: You must pass the the document (and additional queries) as :data variable.
# File lib/elastics/api_stubs.rb, line 486 def self.percolate_count(*vars) ## this is a stub, used for reference super end
########## Elastics.post_bulk_string
##########
API Name: Bulk API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
-
POST
-
“/_bulk”
-
“<< bulk_string >>”
Usage: Elastics.post_bulk_string
:bulk_string => bulk_string # required
Notice: You must pass the :docs array.
# File lib/elastics/api_stubs.rb, line 236 def self.post_bulk_string(*vars) ## this is a stub, used for reference super end
########## Elastics.post_index
##########
API Name: Create Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
-
POST
-
“/<<index>>”
-
settings:
number_of_shards: "<<number_of_shards= 5 >>" number_of_replicas: "<<number_of_replicas= 1 >>"
Usage: Elastics.post_index
:index => nil,
:number_of_shards => 5, :number_of_replicas => 1
Notice: You can also pass the complete data structure as :data variable, so passing settings, mappings, warmers, aliases, …
# File lib/elastics/api_stubs.rb, line 597 def self.post_index(*vars) ## this is a stub, used for reference super end
########## Elastics.post_index_aliases
##########
API Name: Index Aliases API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-
POST
-
“/_aliases”
-
actions: “<<actions>>”
Usage: Elastics.post_index_aliases
:actions => actions # required
Notice: This is the generic interface allowing all the options. You can pass the :actions array or the aliases API structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 878 def self.post_index_aliases(*vars) ## this is a stub, used for reference super end
########## Elastics.post_store
##########
API Name: Index API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
-
POST
-
“/<<index>>/<<type>>”
Usage: Elastics.post_store
:index => nil,
:type => nil
Notice: The id is assigned by elasticsearch; you must pass the :data variable.
# File lib/elastics/api_stubs.rb, line 53 def self.post_store(*vars) ## this is a stub, used for reference super end
########## Elastics.put_cluster_settings
##########
API Name: Cluster Update Settings API URL: www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings
-
PUT
-
“/_cluster/settings”
Usage: Elastics.put_cluster_settings
Notice: You must pass the data structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 1597 def self.put_cluster_settings(*vars) ## this is a stub, used for reference super end
########## Elastics.put_index
##########
API Name: Create Index API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
-
PUT
-
“/<<index>>”
-
settings:
number_of_shards: "<<number_of_shards= 5 >>" number_of_replicas: "<<number_of_replicas= 1 >>"
Usage: Elastics.put_index
:index => nil,
:number_of_shards => 5, :number_of_replicas => 1
Notice: You can also pass the complete data structure as :data variable, so passing settings, mappings, warmers, aliases, …
# File lib/elastics/api_stubs.rb, line 567 def self.put_index(*vars) ## this is a stub, used for reference super end
########## Elastics.put_index_alias
##########
API Name: Index Aliases API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-
PUT
-
“/<<index>>/_alias/<<alias>>”
Usage: Elastics.put_index_alias
:alias => alias, # required
:index => nil
Notice: This is the single index alias. You can pass other options as the :data variable.
# File lib/elastics/api_stubs.rb, line 949 def self.put_index_alias(*vars) ## this is a stub, used for reference super end
########## Elastics.put_index_mapping
##########
API Name: Put Mappings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
-
PUT
-
“/<<index>>/_mapping/<<type>>”
-
“<<type>>”:
properties: "<<properties>>"
Usage: Elastics.put_index_mapping
:properties => properties, # required
:type => nil, :index => nil
# File lib/elastics/api_stubs.rb, line 736 def self.put_index_mapping(*vars) ## this is a stub, used for reference super end
########## Elastics.put_index_template
##########
API Name: Index Templates
API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
-
PUT
-
“/_template/<<template>>”
Usage: Elastics.put_index_template
:template => template # required
Notice: You must pass the template structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 1111 def self.put_index_template(*vars) ## this is a stub, used for reference super end
########## Elastics.put_index_warmer
##########
API Name: Warmers API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
-
PUT
-
“/<<index>>/<<type>>/_warmer/<<warmer>>”
Usage: Elastics.put_index_warmer
:warmer => warmer, # required
:type => nil, :index => nil
Notice: You must pass the warmer structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 1160 def self.put_index_warmer(*vars) ## this is a stub, used for reference super end
########## Elastics.put_percolator
##########
API Name: Percolator API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
-
PUT
-
“/<<index>>/.percolator/<<id>>”
Usage: Elastics.put_percolator
:id => id, # required
:index => nil
Notice: You must pass the the document (and additional queries) as :data variable.
# File lib/elastics/api_stubs.rb, line 511 def self.put_percolator(*vars) ## this is a stub, used for reference super end
########## Elastics.refresh_index
##########
API Name: Refresh API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
-
POST
-
“/<<index>>/_refresh”
Usage: Elastics.refresh_index
:index => nil
# File lib/elastics/api_stubs.rb, line 1364 def self.refresh_index(*vars) ## this is a stub, used for reference super end
########## Elastics.search_by_id
##########
API Name: API URL:
-
GET
-
“/<<index>>/<<type>>/_search”
-
query:
term: _id: "<<id>>"
Usage: Elastics.search_by_id
:id => id, # required
:type => nil, :index => nil
Notice: Get a document without using the get API and without raising any error if it is missing.
# File lib/elastics/api_stubs.rb, line 1725 def self.search_by_id(*vars) ## this is a stub, used for reference super end
########## Elastics.search_exists
##########
API Name: Search Exists API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-exists.html
-
GET
-
“/<<index>>/<<type>>/<<id= ~ >>/_search/exists”
Usage: Elastics.search_exists
:index => nil,
:type => nil, :id => nil
Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 361 def self.search_exists(*vars) ## this is a stub, used for reference super end
########## Elastics.search_shards
##########
API Name: Search Shards API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
-
GET
-
“/<<index>>/<<type>>/_search_shards”
Usage: Elastics.search_shards
:index => nil,
:type => nil
Notice: You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 310 def self.search_shards(*vars) ## this is a stub, used for reference super end
########## Elastics.store
##########
API Name: Index API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
store:
-
PUT
-
“/<<index>>/<<type>>/<<id>>”
Usage: Elastics.store
:id => id, # required
:type => nil, :index => nil
Notice: You must pass the :data variable.
# File lib/elastics/api_stubs.rb, line 27 def self.store(*vars) ## this is a stub, used for reference super end
########## Elastics.synced_flush_index
##########
API Name: Synced Flush API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-synced-flush.html
-
POST
-
“/<<index>>/_flush/synced”
Usage: Elastics.synced_flush_index
:index => nil
Notice: You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 1342 def self.synced_flush_index(*vars) ## this is a stub, used for reference super end
########## Elastics.termvectors
##########
Elastics::Template::API
termvectors:
-
POST
-
“/<<index>>/<<type>>/<<id>>/_termvectors”
Usage: Elastics.termvectors
:id => id, # required
:type => nil, :index => nil
# File lib/elastics/api_stubs.rb, line 257 def self.termvectors(*vars) ## this is a stub, used for reference super end
########## Elastics.types_exists
##########
API Name: Types Exists API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html
-
HEAD
-
“/<<index>>/<<type>>”
Usage: Elastics.types_exists
:index => nil,
:type => nil
# File lib/elastics/api_stubs.rb, line 807 def self.types_exists(*vars) ## this is a stub, used for reference super end
########## Elastics.update
##########
API Name: Update API API URL: www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
update:
-
POST
-
“/<<index>>/<<type>>/<<id>>/_update”
Usage: Elastics.update
:id => id, # required
:type => nil, :index => nil
Notice: You must pass script or doc and the other options as the :data variable.
# File lib/elastics/api_stubs.rb, line 155 def self.update(*vars) ## this is a stub, used for reference super end
########## Elastics.update_index_settings
##########
API Name: Update Indices
Settings API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
-
PUT
-
“/<<index>>/_settings”
Usage: Elastics.update_index_settings
:index => nil
Notice: You can pass the settings structure as the :data variable.
# File lib/elastics/api_stubs.rb, line 973 def self.update_index_settings(*vars) ## this is a stub, used for reference super end
########## Elastics.upgrade_index
##########
API Name: Upgrade API URL: www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
-
POST
-
“/<<index>>/_upgrade”
Usage: Elastics.upgrade_index
:index => nil
Notice: You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 1412 def self.upgrade_index(*vars) ## this is a stub, used for reference super end
########## Elastics.validate
##########
API Name: Validate API URL: www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
validate:
-
GET
-
“/<<index>>/<<type>>/<<id= ~ >>/_validate/query”
Usage: Elastics.validate
:index => nil,
:type => nil, :id => nil
Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
# File lib/elastics/api_stubs.rb, line 387 def self.validate(*vars) ## this is a stub, used for reference super end