Module: Flex

Extended by:
Flex, UtilityMethods
Includes:
ApiStubs, Templates
Included in:
Flex
Defined in:
lib/flex.rb,
lib/flex/tasks.rb,
lib/flex/utils.rb,
lib/flex/errors.rb,
lib/flex/logger.rb,
lib/flex/result.rb,
lib/flex/prog_bar.rb,
lib/flex/template.rb,
lib/flex/api_stubs.rb,
lib/flex/templates.rb,
lib/flex/variables.rb,
lib/flex/deprecation.rb,
lib/flex/result/bulk.rb,
lib/flex/struct/hash.rb,
lib/flex/struct/array.rb,
lib/flex/configuration.rb,
lib/flex/result/search.rb,
lib/flex/template/tags.rb,
lib/flex/result/document.rb,
lib/flex/struct/prunable.rb,
lib/flex/template/common.rb,
lib/flex/template/logger.rb,
lib/flex/template/search.rb,
lib/flex/utility_methods.rb,
lib/flex/class_proxy/base.rb,
lib/flex/result/multi_get.rb,
lib/flex/struct/paginable.rb,
lib/flex/struct/symbolize.rb,
lib/flex/template/partial.rb,
lib/flex/http_clients/base.rb,
lib/flex/http_clients/loader.rb,
lib/flex/http_clients/patron.rb,
lib/flex/template/slim_search.rb,
lib/flex/class_proxy/templates.rb,
lib/flex/http_clients/rest_client.rb,
lib/flex/class_proxy/templates/doc.rb,
lib/flex/class_proxy/templates/search.rb

Defined Under Namespace

Modules: ApiStubs, ClassProxy, Deprecation, HttpClients, Loader, Model, RelatedModel, Struct, Templates, UtilityMethods, Utils Classes: ArgumentError, DocumentMappingError, ExistingIndexError, HttpError, Logger, MissingHttpClientError, MissingIndexEntryError, MissingParentError, MissingPartialError, MissingVariableError, ProgBar, Result, SourceError, Tasks, Template, Variables

Constant Summary collapse

VERSION = 
File.read(File.expand_path('../../VERSION', __FILE__)).strip
LIB_PATHS = 
[ File.dirname(__FILE__) ]
Vars =

shorter alias

Variables
Configuration = 
OpenStruct.new :result_extenders => [ Result::Document,
                       Result::Search,
                       Result::MultiGet,
                       Result::Bulk ],
:logger           => Logger.new(STDERR),
:variables        => Vars.new( :index      => nil,
                               :type       => nil,
                               :params     => {},
                               :no_pruning => [] ),
:config_file      => './config/flex.yml',
:flex_dir         => './flex',
:http_client      => HttpClients::Loader.new_http_client
Conf =

shorter alias

Configuration
Prunable = 
Struct::Prunable

Instance Attribute Summary

Attributes included from Templates

#contexts

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UtilityMethods

build_bulk_string, doc, dump_all, dump_one, json2yaml, post_bulk_collection, reload!, scan_all, scan_search, search, slim_search, yaml2json

Methods included from Templates

included

Class Method Details

.add_index_alias(*vars) ⇒ Object

########## Flex.add_index_alias ##########

--------------
Flex::Template
---
add_index_alias:
- PUT
- /<<index>>/_alias/<<alias>>

Usage:
Flex.add_index_alias :alias => alias,  # required
                     :index => "flex_test_index"



453
454
455
456
 
# File 'lib/flex/api_stubs.rb', line 453

def Flex.add_index_alias(*vars)
  ## this is a stub, used for reference
  super
end

.analyze_index(*vars) ⇒ Object

########## Flex.analyze_index ##########

--------------
Flex::Template
---
analyze_index:
- GET
- /<<index>>/_analyze

Usage:
Flex.analyze_index :index => "flex_test_index"



506
507
508
509
 
# File 'lib/flex/api_stubs.rb', line 506

def Flex.analyze_index(*vars)
  ## this is a stub, used for reference
  super
end

.close_index(*vars) ⇒ Object

########## Flex.close_index ##########

--------------
Flex::Template
---
close_index:
- POST
- /<<index>>/_close

Usage:
Flex.close_index :index => "flex_test_index"



606
607
608
609
 
# File 'lib/flex/api_stubs.rb', line 606

def Flex.close_index(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_health(*vars) ⇒ Object

########## Flex.cluster_health ##########

--------------
Flex::Template
---
cluster_health:
- GET
- /_cluster/health/<<index>>

Usage:
Flex.cluster_health :index => "flex_test_index"



1123
1124
1125
1126
 
# File 'lib/flex/api_stubs.rb', line 1123

def Flex.cluster_health(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_nodes_hot_threads(*vars) ⇒ Object

########## Flex.cluster_nodes_hot_threads ##########

--------------
Flex::Template
---
cluster_nodes_hot_threads:
- GET
- /_nodes/<<nodes= ~ >>/hot_threads

Usage:
Flex.cluster_nodes_hot_threads :nodes => nil



1244
1245
1246
1247
 
# File 'lib/flex/api_stubs.rb', line 1244

def Flex.cluster_nodes_hot_threads(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_nodes_info(*vars) ⇒ Object

########## Flex.cluster_nodes_info ##########

--------------
Flex::Template
---
cluster_nodes_info:
- GET
- /_nodes/<<nodes= ~ >>/<<endpoint= ~ >>

Usage:
Flex.cluster_nodes_info :nodes    => nil,
                        :endpoint => nil



1192
1193
1194
1195
 
# File 'lib/flex/api_stubs.rb', line 1192

def Flex.cluster_nodes_info(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_nodes_shutdown(*vars) ⇒ Object

########## Flex.cluster_nodes_shutdown ##########

--------------
Flex::Template
---
cluster_nodes_shutdown:
- POST
- /_cluster/nodes/<<nodes= ~ >>/_shutdown

Usage:
Flex.cluster_nodes_shutdown :nodes => nil



1227
1228
1229
1230
 
# File 'lib/flex/api_stubs.rb', line 1227

def Flex.cluster_nodes_shutdown(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_nodes_stats(*vars) ⇒ Object

########## Flex.cluster_nodes_stats ##########

--------------
Flex::Template
---
cluster_nodes_stats:
- GET
- /_nodes/<<nodes= ~ >>/stats/<<endpoint= ~ >>

Usage:
Flex.cluster_nodes_stats :nodes    => nil,
                         :endpoint => nil



1210
1211
1212
1213
 
# File 'lib/flex/api_stubs.rb', line 1210

def Flex.cluster_nodes_stats(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_reroute(*vars) ⇒ Object

########## Flex.cluster_reroute ##########

--------------
Flex::Template
---
cluster_reroute:
- POST
- /_cluster/reroute

Usage:
Flex.cluster_reroute



1261
1262
1263
1264
 
# File 'lib/flex/api_stubs.rb', line 1261

def Flex.cluster_reroute(*vars)
  ## this is a stub, used for reference
  super
end

.cluster_state(*vars) ⇒ Object

########## Flex.cluster_state ##########

--------------
Flex::Template
---
cluster_state:
- GET
- /_cluster/state

Usage:
Flex.cluster_state



1140
1141
1142
1143
 
# File 'lib/flex/api_stubs.rb', line 1140

def Flex.cluster_state(*vars)
  ## this is a stub, used for reference
  super
end

.count(*vars) ⇒ Object

########## Flex.count ##########

--------------
Flex::Template
---
count:
- GET
- /<<index>>/<<type>>/_count

Usage:
Flex.count :index => "flex_test_index",
           :type  => nil



264
265
266
267
 
# File 'lib/flex/api_stubs.rb', line 264

def Flex.count(*vars)
  ## this is a stub, used for reference
  super
end

.create_index(*vars) ⇒ Object

########## Flex.create_index ##########

--------------
Flex::Template
---
create_index:
- PUT
- /<<index>>
- settings:
    number_of_shards: <<number_of_shards= 5 >>
    number_of_replicas: <<number_of_replicas= 1 >>

Usage:
Flex.create_index :index              => "flex_test_index",
                  :number_of_shards   => 5,
                  :number_of_replicas => 1



550
551
552
553
 
# File 'lib/flex/api_stubs.rb', line 550

def Flex.create_index(*vars)
  ## this is a stub, used for reference
  super
end

.delete(*vars) ⇒ Object

########## Flex.delete ##########

--------------
Flex::Template
---
delete:
- DELETE
- /<<index>>/<<type>>/<<id>>

Usage:
Flex.delete :id    => id,    # required
            :type  => nil,
            :index => "flex_test_index"



78
79
80
81
 
# File 'lib/flex/api_stubs.rb', line 78

def Flex.delete(*vars)
  ## this is a stub, used for reference
  super
end

.delete_by_query(*vars) ⇒ Object

########## Flex.delete_by_query ##########

--------------
Flex::Template
---
delete_by_query:
- DELETE
- /<<index>>/<<type>>/_query

Usage:
Flex.delete_by_query :index => "flex_test_index",
                     :type  => nil



282
283
284
285
 
# File 'lib/flex/api_stubs.rb', line 282

def Flex.delete_by_query(*vars)
  ## this is a stub, used for reference
  super
end

.delete_index(*vars) ⇒ Object

########## Flex.delete_index ##########

--------------
Flex::Template
---
delete_index:
- DELETE
- /<<index>>

Usage:
Flex.delete_index :index => "flex_test_index"



589
590
591
592
 
# File 'lib/flex/api_stubs.rb', line 589

def Flex.delete_index(*vars)
  ## this is a stub, used for reference
  super
end

.delete_index_alias(*vars) ⇒ Object

########## Flex.delete_index_alias ##########

--------------
Flex::Template
---
delete_index_alias:
- DELETE
- /<<index>>/_alias/<<alias>>

Usage:
Flex.delete_index_alias :alias => alias,  # required
                        :index => "flex_test_index"



471
472
473
474
 
# File 'lib/flex/api_stubs.rb', line 471

def Flex.delete_index_alias(*vars)
  ## this is a stub, used for reference
  super
end

.delete_index_mapping(*vars) ⇒ Object

########## Flex.delete_index_mapping ##########

--------------
Flex::Template
---
delete_index_mapping:
- DELETE
- /<<index>>/<<type>>

Usage:
Flex.delete_index_mapping :index => "flex_test_index",
                          :type  => nil



753
754
755
756
 
# File 'lib/flex/api_stubs.rb', line 753

def Flex.delete_index_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.delete_index_template(*vars) ⇒ Object

########## Flex.delete_index_template ##########

--------------
Flex::Template
---
delete_index_template:
- DELETE
- /_template/<<template>>

Usage:
Flex.delete_index_template :template => template  # required



890
891
892
893
 
# File 'lib/flex/api_stubs.rb', line 890

def Flex.delete_index_template(*vars)
  ## this is a stub, used for reference
  super
end

.delete_index_warmer(*vars) ⇒ Object

########## Flex.delete_index_warmer ##########

--------------
Flex::Template
---
delete_index_warmer:
- DELETE
- /<<index>>/_warmer/<<warmer= ~ >>

Usage:
Flex.delete_index_warmer :index  => "flex_test_index",
                         :warmer => nil



944
945
946
947
 
# File 'lib/flex/api_stubs.rb', line 944

def Flex.delete_index_warmer(*vars)
  ## this is a stub, used for reference
  super
end

.delete_mapping(*vars) ⇒ Object

########## Flex.delete_mapping ##########

--------------
Flex::Template
---
delete_mapping:
- DELETE
- /<<index>>/<<type>>

Usage:
Flex.delete_mapping :index => "flex_test_index",
                    :type  => nil



771
772
773
774
 
# File 'lib/flex/api_stubs.rb', line 771

def Flex.delete_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.delete_percolator(*vars) ⇒ Object

########## Flex.delete_percolator ##########

--------------
Flex::Template
---
delete_percolator:
- DELETE
- /_percolator/<<index>>/<<percolator>>

Usage:
Flex.delete_percolator :percolator => percolator,  # required
                       :index      => "flex_test_index"



228
229
230
231
 
# File 'lib/flex/api_stubs.rb', line 228

def Flex.delete_percolator(*vars)
  ## this is a stub, used for reference
  super
end

.exist?(*vars) ⇒ Boolean

########## Flex.exist? ##########

--------------
Flex::Template
---
exist?:
- HEAD
- /<<index>>

Usage:
Flex.exist? :index => "flex_test_index"

Returns:

  • (Boolean) 


1085
1086
1087
1088
 
# File 'lib/flex/api_stubs.rb', line 1085

def Flex.exist?(*vars)
  ## this is a stub, used for reference
  super
end

.explain(*vars) ⇒ Object

########## Flex.explain ##########

--------------
Flex::Template
---
explain:
- GET
- /<<index>>/<<type>>/<<id>>/_explain

Usage:
Flex.explain :id    => id,    # required
             :type  => nil,
             :index => "flex_test_index"



357
358
359
360
 
# File 'lib/flex/api_stubs.rb', line 357

def Flex.explain(*vars)
  ## this is a stub, used for reference
  super
end

.flush_index(*vars) ⇒ Object

########## Flex.flush_index ##########

--------------
Flex::Template
---
flush_index:
- POST
- /<<index>>/_flush

Usage:
Flex.flush_index :index => "flex_test_index"



822
823
824
825
 
# File 'lib/flex/api_stubs.rb', line 822

def Flex.flush_index(*vars)
  ## this is a stub, used for reference
  super
end

.gateway_snapshot(*vars) ⇒ Object

########## Flex.gateway_snapshot ##########

--------------
Flex::Template
---
gateway_snapshot:
- POST
- /<<index>>/_gateway/snapshot

Usage:
Flex.gateway_snapshot :index => "flex_test_index"



839
840
841
842
 
# File 'lib/flex/api_stubs.rb', line 839

def Flex.gateway_snapshot(*vars)
  ## this is a stub, used for reference
  super
end

.get(*vars) ⇒ Object

########## Flex.get ##########

--------------
Flex::Template
---
get:
- GET
- /<<index>>/<<type>>/<<id>>

Usage:
Flex.get :id    => id,    # required
         :type  => nil,
         :index => "flex_test_index"



116
117
118
119
 
# File 'lib/flex/api_stubs.rb', line 116

def Flex.get(*vars)
  ## this is a stub, used for reference
  super
end

.get_cluster_settings(*vars) ⇒ Object

########## Flex.get_cluster_settings ##########

--------------
Flex::Template
---
get_cluster_settings:
- GET
- /_cluster/settings

Usage:
Flex.get_cluster_settings



1174
1175
1176
1177
 
# File 'lib/flex/api_stubs.rb', line 1174

def Flex.get_cluster_settings(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_alias(*vars) ⇒ Object

########## Flex.get_index_alias ##########

--------------
Flex::Template
---
get_index_alias:
- GET
- /<<index>>/_alias/<<alias= '*' >>

Usage:
Flex.get_index_alias :index => "flex_test_index",
                     :alias => "*"



489
490
491
492
 
# File 'lib/flex/api_stubs.rb', line 489

def Flex.get_index_alias(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_aliases(*vars) ⇒ Object

########## Flex.get_index_aliases ##########

--------------
Flex::Template
---
get_index_aliases:
- GET
- /<<index>>/_aliases

Usage:
Flex.get_index_aliases :index => "flex_test_index"



435
436
437
438
 
# File 'lib/flex/api_stubs.rb', line 435

def Flex.get_index_aliases(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_mapping(*vars) ⇒ Object

########## Flex.get_index_mapping ##########

--------------
Flex::Template
---
get_index_mapping:
- GET
- /<<index>>/<<type>>/_mapping

Usage:
Flex.get_index_mapping :index => "flex_test_index",
                       :type  => nil



675
676
677
678
 
# File 'lib/flex/api_stubs.rb', line 675

def Flex.get_index_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_settings(*vars) ⇒ Object

########## Flex.get_index_settings ##########

--------------
Flex::Template
---
get_index_settings:
- GET
- /<<index>>/_settings

Usage:
Flex.get_index_settings :index => "flex_test_index"



640
641
642
643
 
# File 'lib/flex/api_stubs.rb', line 640

def Flex.get_index_settings(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_template(*vars) ⇒ Object

########## Flex.get_index_template ##########

--------------
Flex::Template
---
get_index_template:
- GET
- /_template/<<template>>

Usage:
Flex.get_index_template :template => template  # required



907
908
909
910
 
# File 'lib/flex/api_stubs.rb', line 907

def Flex.get_index_template(*vars)
  ## this is a stub, used for reference
  super
end

.get_index_warmer(*vars) ⇒ Object

########## Flex.get_index_warmer ##########

--------------
Flex::Template
---
get_index_warmer:
- GET
- /<<index>>/_warmer/<<warmer= ~ >>

Usage:
Flex.get_index_warmer :index  => "flex_test_index",
                      :warmer => nil



962
963
964
965
 
# File 'lib/flex/api_stubs.rb', line 962

def Flex.get_index_warmer(*vars)
  ## this is a stub, used for reference
  super
end

.get_mapping(*vars) ⇒ Object

########## Flex.get_mapping ##########

--------------
Flex::Template
---
get_mapping:
- GET
- /<<index>>/<<type>>/_mapping

Usage:
Flex.get_mapping :index => "flex_test_index",
                 :type  => nil



693
694
695
696
 
# File 'lib/flex/api_stubs.rb', line 693

def Flex.get_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.get_settings(*vars) ⇒ Object

########## Flex.get_settings ##########

--------------
Flex::Template
---
get_settings:
- GET
- /<<index>>/_settings

Usage:
Flex.get_settings :index => "flex_test_index"



657
658
659
660
 
# File 'lib/flex/api_stubs.rb', line 657

def Flex.get_settings(*vars)
  ## this is a stub, used for reference
  super
end

.get_source(*vars) ⇒ Object

########## Flex.get_source ##########

--------------
Flex::Template
---
get_source:
- GET
- /<<index>>/<<type>>/<<id>>/_source

Usage:
Flex.get_source :id    => id,    # required
                :type  => nil,
                :index => "flex_test_index"



135
136
137
138
 
# File 'lib/flex/api_stubs.rb', line 135

def Flex.get_source(*vars)
  ## this is a stub, used for reference
  super
end

.index_clearcache(*vars) ⇒ Object

########## Flex.index_clearcache ##########

--------------
Flex::Template
---
index_clearcache:
- POST
- /<<index>>/_cache/clear

Usage:
Flex.index_clearcache :index => "flex_test_index"



1051
1052
1053
1054
 
# File 'lib/flex/api_stubs.rb', line 1051

def Flex.index_clearcache(*vars)
  ## this is a stub, used for reference
  super
end

.index_segments(*vars) ⇒ Object

########## Flex.index_segments ##########

--------------
Flex::Template
---
index_segments:
- GET
- /<<index>>/_segments

Usage:
Flex.index_segments :index => "flex_test_index"



1034
1035
1036
1037
 
# File 'lib/flex/api_stubs.rb', line 1034

def Flex.index_segments(*vars)
  ## this is a stub, used for reference
  super
end

.index_stats(*vars) ⇒ Object

########## Flex.index_stats ##########

--------------
Flex::Template
---
index_stats:
- GET
- /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>

Usage:
Flex.index_stats :index    => "flex_test_index",
                 :endpoint => nil,
                 :names    => nil



981
982
983
984
 
# File 'lib/flex/api_stubs.rb', line 981

def Flex.index_stats(*vars)
  ## this is a stub, used for reference
  super
end

.index_status(*vars) ⇒ Object

########## Flex.index_status ##########

--------------
Flex::Template
---
index_status:
- GET
- /<<index>>/_status

Usage:
Flex.index_status :index => "flex_test_index"



1017
1018
1019
1020
 
# File 'lib/flex/api_stubs.rb', line 1017

def Flex.index_status(*vars)
  ## this is a stub, used for reference
  super
end

.indices_exists(*vars) ⇒ Object

########## Flex.indices_exists ##########

--------------
Flex::Template
---
indices_exists:
- HEAD
- /<<index>>

Usage:
Flex.indices_exists :index => "flex_test_index"



1068
1069
1070
1071
 
# File 'lib/flex/api_stubs.rb', line 1068

def Flex.indices_exists(*vars)
  ## this is a stub, used for reference
  super
end

.match_all(*vars) ⇒ Object

########## Flex.match_all ##########

--------------
Flex::Template
---
match_all:
- GET
- /<<index>>/<<type>>/_search
- query:
    match_all: {}

Usage:
Flex.match_all :index => "flex_test_index",
               :type  => nil



377
378
379
380
 
# File 'lib/flex/api_stubs.rb', line 377

def Flex.match_all(*vars)
  ## this is a stub, used for reference
  super
end

.mlt(*vars) ⇒ Object

########## Flex.mlt ##########

--------------
Flex::Template
---
mlt:
- GET
- /<<index>>/<<type>>/<<id>>/_mlt

Usage:
Flex.mlt :id    => id,    # required
         :type  => nil,
         :index => "flex_test_index"



320
321
322
323
 
# File 'lib/flex/api_stubs.rb', line 320

def Flex.mlt(*vars)
  ## this is a stub, used for reference
  super
end

.more_like_this(*vars) ⇒ Object

########## Flex.more_like_this ##########

--------------
Flex::Template
---
more_like_this:
- GET
- /<<index>>/<<type>>/<<id>>/_mlt

Usage:
Flex.more_like_this :id    => id,    # required
                    :type  => nil,
                    :index => "flex_test_index"



301
302
303
304
 
# File 'lib/flex/api_stubs.rb', line 301

def Flex.more_like_this(*vars)
  ## this is a stub, used for reference
  super
end

.multi_get(*vars) ⇒ Object

########## Flex.multi_get ##########

--------------
Flex::Template
---
multi_get:
- GET
- /<<index>>/<<type>>/_mget
- ids: << ids >>

Usage:
Flex.multi_get :ids   => ids,   # required
               :type  => nil,
               :index => "flex_test_index"



155
156
157
158
 
# File 'lib/flex/api_stubs.rb', line 155

def Flex.multi_get(*vars)
  ## this is a stub, used for reference
  super
end

.open_index(*vars) ⇒ Object

########## Flex.open_index ##########

--------------
Flex::Template
---
open_index:
- POST
- /<<index>>/_close

Usage:
Flex.open_index :index => "flex_test_index"



623
624
625
626
 
# File 'lib/flex/api_stubs.rb', line 623

def Flex.open_index(*vars)
  ## this is a stub, used for reference
  super
end

.optimize_index(*vars) ⇒ Object

########## Flex.optimize_index ##########

--------------
Flex::Template
---
optimize_index:
- POST
- /<<index>>/_optimize

Usage:
Flex.optimize_index :index => "flex_test_index"



805
806
807
808
 
# File 'lib/flex/api_stubs.rb', line 805

def Flex.optimize_index(*vars)
  ## this is a stub, used for reference
  super
end

.percolate(*vars) ⇒ Object

########## Flex.percolate ##########

--------------
Flex::Template
---
percolate:
- GET
- /<<index>>/<<type>>/_percolate

Usage:
Flex.percolate :index => "flex_test_index",
               :type  => nil



192
193
194
195
 
# File 'lib/flex/api_stubs.rb', line 192

def Flex.percolate(*vars)
  ## this is a stub, used for reference
  super
end

.post_bulk_string(*vars) ⇒ Object

########## Flex.post_bulk_string ##########

--------------
Flex::Template
---
post_bulk_string:
- POST
- /_bulk
- << bulk_string >>

Usage:
Flex.bulk :bulk_string => bulk_string  # required



246
247
248
249
 
# File 'lib/flex/api_stubs.rb', line 246

def Flex.post_bulk_string(*vars)
  ## this is a stub, used for reference
  super
end

.post_index(*vars) ⇒ Object

########## Flex.post_index ##########

--------------
Flex::Template
---
post_index:
- POST
- /<<index>>
- settings:
    number_of_shards: <<number_of_shards= 5 >>
    number_of_replicas: <<number_of_replicas= 1 >>

Usage:
Flex.post_index :index              => "flex_test_index",
                :number_of_shards   => 5,
                :number_of_replicas => 1



572
573
574
575
 
# File 'lib/flex/api_stubs.rb', line 572

def Flex.post_index(*vars)
  ## this is a stub, used for reference
  super
end

.post_index_aliases(*vars) ⇒ Object

########## Flex.post_index_aliases ##########

--------------
Flex::Template
---
post_index_aliases:
- POST
- /_aliases

Usage:
Flex.post_index_aliases



418
419
420
421
 
# File 'lib/flex/api_stubs.rb', line 418

def Flex.post_index_aliases(*vars)
  ## this is a stub, used for reference
  super
end

.post_store(*vars) ⇒ Object

########## Flex.post_store ##########

--------------
Flex::Template
---
post_store:
- POST
- /<<index>>/<<type>>

Usage:
Flex.post_store :index => "flex_test_index",
                :type  => nil



59
60
61
62
 
# File 'lib/flex/api_stubs.rb', line 59

def Flex.post_store(*vars)
  ## this is a stub, used for reference
  super
end

.put_cluster_settings(*vars) ⇒ Object

########## Flex.put_cluster_settings ##########

--------------
Flex::Template
---
put_cluster_settings:
- PUT
- /_cluster/settings

Usage:
Flex.put_cluster_settings



1157
1158
1159
1160
 
# File 'lib/flex/api_stubs.rb', line 1157

def Flex.put_cluster_settings(*vars)
  ## this is a stub, used for reference
  super
end

.put_index(*vars) ⇒ Object

########## Flex.put_index ##########

--------------
Flex::Template
---
put_index:
- PUT
- /<<index>>
- settings:
    number_of_shards: <<number_of_shards= 5 >>
    number_of_replicas: <<number_of_replicas= 1 >>

Usage:
Flex.put_index :index              => "flex_test_index",
               :number_of_shards   => 5,
               :number_of_replicas => 1



528
529
530
531
 
# File 'lib/flex/api_stubs.rb', line 528

def Flex.put_index(*vars)
  ## this is a stub, used for reference
  super
end

.put_index_mapping(*vars) ⇒ Object

########## Flex.put_index_mapping ##########

--------------
Flex::Template
---
put_index_mapping:
- PUT
- /<<index>>/<<type>>/_mapping
- <<type>>:
    properties: <<properties>>

Usage:
Flex.put_index_mapping :properties => properties,  # required
                       :type       => nil,
                       :index      => "flex_test_index"



714
715
716
717
 
# File 'lib/flex/api_stubs.rb', line 714

def Flex.put_index_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.put_index_template(*vars) ⇒ Object

########## Flex.put_index_template ##########

--------------
Flex::Template
---
put_index_template:
- PUT
- /_template/<<template>>

Usage:
Flex.put_index_template :template => template  # required



873
874
875
876
 
# File 'lib/flex/api_stubs.rb', line 873

def Flex.put_index_template(*vars)
  ## this is a stub, used for reference
  super
end

.put_index_warmer(*vars) ⇒ Object

########## Flex.put_index_warmer ##########

--------------
Flex::Template
---
put_index_warmer:
- PUT
- /<<index>>/<<type>>/_warmer/<<warmer>>

Usage:
Flex.put_index_warmer :warmer => warmer,  # required
                      :type   => nil,
                      :index  => "flex_test_index"



926
927
928
929
 
# File 'lib/flex/api_stubs.rb', line 926

def Flex.put_index_warmer(*vars)
  ## this is a stub, used for reference
  super
end

.put_mapping(*vars) ⇒ Object

########## Flex.put_mapping ##########

--------------
Flex::Template
---
put_mapping:
- PUT
- /<<index>>/<<type>>/_mapping
- <<type>>:
    properties: <<properties>>

Usage:
Flex.put_mapping :properties => properties,  # required
                 :type       => nil,
                 :index      => "flex_test_index"



735
736
737
738
 
# File 'lib/flex/api_stubs.rb', line 735

def Flex.put_mapping(*vars)
  ## this is a stub, used for reference
  super
end

.put_percolator(*vars) ⇒ Object

########## Flex.put_percolator ##########

--------------
Flex::Template
---
put_percolator:
- PUT
- /_percolator/<<index>>/<<percolator>>

Usage:
Flex.put_percolator :percolator => percolator,  # required
                    :index      => "flex_test_index"



210
211
212
213
 
# File 'lib/flex/api_stubs.rb', line 210

def Flex.put_percolator(*vars)
  ## this is a stub, used for reference
  super
end

.put_store(*vars) ⇒ Object

########## Flex.put_store ##########

--------------
Flex::Template
---
put_store:
- PUT
- /<<index>>/<<type>>/<<id>>

Usage:
Flex.put_store :id    => id,    # required
               :type  => nil,
               :index => "flex_test_index"



41
42
43
44
 
# File 'lib/flex/api_stubs.rb', line 41

def Flex.put_store(*vars)
  ## this is a stub, used for reference
  super
end

.refresh_index(*vars) ⇒ Object

########## Flex.refresh_index ##########

--------------
Flex::Template
---
refresh_index:
- POST
- /<<index>>/_refresh

Usage:
Flex.refresh_index :index => "flex_test_index"



788
789
790
791
 
# File 'lib/flex/api_stubs.rb', line 788

def Flex.refresh_index(*vars)
  ## this is a stub, used for reference
  super
end

.remove(*vars) ⇒ Object

########## Flex.remove ##########

--------------
Flex::Template
---
remove:
- DELETE
- /<<index>>/<<type>>/<<id>>

Usage:
Flex.remove :id    => id,    # required
            :type  => nil,
            :index => "flex_test_index"



97
98
99
100
 
# File 'lib/flex/api_stubs.rb', line 97

def Flex.remove(*vars)
  ## this is a stub, used for reference
  super
end

.search_by_id(*vars) ⇒ Object

########## Flex.search_by_id ##########

--------------
Flex::Template
---
search_by_id:
- GET
- /<<index>>/<<type>>/_search
- query:
    term:
      _id: <<id>>

Usage:
Flex.search_by_id :id      => id,    # required
                  :type    => nil,
                  :index   => "flex_test_index",



399
400
401
402
 
# File 'lib/flex/api_stubs.rb', line 399

def Flex.search_by_id(*vars)
  ## this is a stub, used for reference
  super
end

.stats(*vars) ⇒ Object

########## Flex.stats ##########

--------------
Flex::Template
---
stats:
- GET
- /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>

Usage:
Flex.stats :index    => "flex_test_index",
           :endpoint => nil,
           :names    => nil



1000
1001
1002
1003
 
# File 'lib/flex/api_stubs.rb', line 1000

def Flex.stats(*vars)
  ## this is a stub, used for reference
  super
end

.store(*vars) ⇒ Object

########## Flex.store ##########

--------------
Flex::Template
---
store:
- PUT
- /<<index>>/<<type>>/<<id>>

Usage:
Flex.store :id    => id,    # required
           :type  => nil,
           :index => "flex_test_index"



22
23
24
25
 
# File 'lib/flex/api_stubs.rb', line 22

def Flex.store(*vars)
  ## this is a stub, used for reference
  super
end

.types_exists(*vars) ⇒ Object

########## Flex.types_exists ##########

--------------
Flex::Template
---
types_exists:
- HEAD
- /<<index>>/<<type>>

Usage:
Flex.types_exists :index => "flex_test_index",
                  :type  => nil



1103
1104
1105
1106
 
# File 'lib/flex/api_stubs.rb', line 1103

def Flex.types_exists(*vars)
  ## this is a stub, used for reference
  super
end

.update(*vars) ⇒ Object

########## Flex.update ##########

--------------
Flex::Template
---
update:
- POST
- /<<index>>/<<type>>/<<id>>/_update

Usage:
Flex.update :id    => id,    # required
            :type  => nil,
            :index => "flex_test_index"



174
175
176
177
 
# File 'lib/flex/api_stubs.rb', line 174

def Flex.update(*vars)
  ## this is a stub, used for reference
  super
end

.update_index_settings(*vars) ⇒ Object

########## Flex.update_index_settings ##########

--------------
Flex::Template
---
update_index_settings:
- PUT
- /<<index>>/_settings

Usage:
Flex.update_index_settings :index => "flex_test_index"



856
857
858
859
 
# File 'lib/flex/api_stubs.rb', line 856

def Flex.update_index_settings(*vars)
  ## this is a stub, used for reference
  super
end

.validate(*vars) ⇒ Object

########## Flex.validate ##########

--------------
Flex::Template
---
validate:
- GET
- /<<index>>/<<type>>/_validate/query

Usage:
Flex.validate :index => "flex_test_index",
              :type  => nil



338
339
340
341
 
# File 'lib/flex/api_stubs.rb', line 338

def Flex.validate(*vars)
  ## this is a stub, used for reference
  super
end

Instance Method Details

#bulk(*vars) ⇒ Object 



48
49
50
51
52
 
# File 'lib/flex/deprecation.rb', line 48

def bulk(*vars)
  Deprecation.warn 'Flex.bulk(:lines => lines_bulk_string)', 'Flex.post_bulk_string(:bulk_string => lines_bulk_string)'
  vars = Vars.new(*vars)
  post_bulk_string(:bulk_string => vars[:lines])
end

#delete_collection(collection, options = {}) ⇒ Object 



43
44
45
46
 
# File 'lib/flex/deprecation.rb', line 43

def delete_collection(collection, options={})
  Deprecation.warn 'Flex.delete_collection(collection)', 'Flex.post_bulk_collection(collection, :action => "delete")'
  post_bulk_collection(collection, options.merge(:action => 'delete'))
end

#import_collection(collection, options = {}) ⇒ Object 



38
39
40
41
 
# File 'lib/flex/deprecation.rb', line 38

def import_collection(collection, options={})
  Deprecation.warn 'Flex.import_collection', 'Flex.post_bulk_collection'
  post_bulk_collection(collection, options.merge(:action => 'index'))
end

#info(*names) ⇒ Object

Deprecation of Flex methods ###



28
29
30
31
 
# File 'lib/flex/deprecation.rb', line 28

def info(*names)
  Deprecation.warn 'Flex.info', 'Flex.doc'
  doc *names
end

#process_bulk(options = {}) ⇒ Object 



33
34
35
36
 
# File 'lib/flex/deprecation.rb', line 33

def process_bulk(options={})
  Deprecation.warn 'Flex.process_bulk(:collection => collection)', 'Flex.post_bulk_collection(collection, options)'
  post_bulk_collection(options.delete(:collection), options)
end