@@ -7,7 +7,7 @@ class IndicesClient(NamespacedClient):
7
7
def analyze (self , index = None , body = None , params = None ):
8
8
"""
9
9
Perform the analysis process on a text and return the tokens breakdown of the text.
10
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html/ >`_
10
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html>`_
11
11
12
12
:arg index: The name of the index to scope the operation
13
13
:arg body: The text on which the analysis should be performed
@@ -32,7 +32,7 @@ def refresh(self, index=None, params=None):
32
32
"""
33
33
Explicitly refresh one or more index, making all operations performed
34
34
since the last refresh available for search.
35
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html/ >`_
35
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html>`_
36
36
37
37
:arg index: A comma-separated list of index names; use `_all` or empty
38
38
string to perform the operation on all indices
@@ -47,7 +47,7 @@ def refresh(self, index=None, params=None):
47
47
def flush (self , index = None , params = None ):
48
48
"""
49
49
Explicitly flush one or more indices.
50
- `<http://http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html/ >`_
50
+ `<http://http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html>`_
51
51
52
52
:arg index: A comma-separated list of index names; use `_all` or empty
53
53
string for all indices
@@ -65,7 +65,7 @@ def flush(self, index=None, params=None):
65
65
def create (self , index , body = None , params = None ):
66
66
"""
67
67
Create an index in Elasticsearch.
68
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html/ >`_
68
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>`_
69
69
70
70
:arg index: The name of the index
71
71
:arg body: The configuration for the index (`settings` and `mappings`)
@@ -80,7 +80,7 @@ def create(self, index, body=None, params=None):
80
80
def open (self , index , params = None ):
81
81
"""
82
82
Open a closed index to make it available for search.
83
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html/ >`_
83
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html>`_
84
84
85
85
:arg index: The name of the index
86
86
:arg master_timeout: Specify timeout for connection to master
@@ -95,7 +95,7 @@ def close(self, index, params=None):
95
95
"""
96
96
Close an index to remove it's overhead from the cluster. Closed index
97
97
is blocked for read/write operations.
98
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html/ >`_
98
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html>`_
99
99
100
100
:arg index: The name of the index
101
101
:arg master_timeout: Specify timeout for connection to master
@@ -109,7 +109,7 @@ def close(self, index, params=None):
109
109
def delete (self , index = None , params = None ):
110
110
"""
111
111
Delete an index in Elasticsearch
112
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html/ >`_
112
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html>`_
113
113
114
114
:arg index: A comma-separated list of indices to delete; use `_all` or
115
115
empty string to delete all indices
@@ -124,7 +124,7 @@ def delete(self, index=None, params=None):
124
124
def exists (self , index , params = None ):
125
125
"""
126
126
Return a boolean indicating whether given index exists.
127
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-indices-exists.html/ >`_
127
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-indices-exists.html>`_
128
128
129
129
:arg index: A list of indices to check
130
130
"""
@@ -138,7 +138,7 @@ def exists(self, index, params=None):
138
138
def exists_type (self , index , doc_type , params = None ):
139
139
"""
140
140
Check if a type/types exists in an index/indices.
141
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html/ >`_
141
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html>`_
142
142
143
143
:arg index: A comma-separated list of index names; use `_all` to check
144
144
the types across all indices
@@ -156,7 +156,7 @@ def exists_type(self, index, doc_type, params=None):
156
156
def snapshot_index (self , index = None , params = None ):
157
157
"""
158
158
Explicitly perform a snapshot through the gateway of one or more indices (backup them).
159
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html/ >`_
159
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html>`_
160
160
161
161
:arg index: A comma-separated list of index names; use `_all` or empty
162
162
string for all indices
@@ -171,7 +171,7 @@ def snapshot_index(self, index=None, params=None):
171
171
def put_mapping (self , index , doc_type , body , params = None ):
172
172
"""
173
173
Register specific mapping definition for a specific type.
174
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html/ >`_
174
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html>`_
175
175
176
176
:arg index: A comma-separated list of index names; use `_all` to
177
177
perform the operation on all indices
@@ -190,7 +190,7 @@ def put_mapping(self, index, doc_type, body, params=None):
190
190
def get_mapping (self , index = None , doc_type = None , params = None ):
191
191
"""
192
192
Retrieve mapping definition of index or index/type.
193
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html/ >`_
193
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html>`_
194
194
195
195
:arg index: A comma-separated list of index names; use `_all` or empty
196
196
string for all indices
@@ -204,7 +204,7 @@ def get_mapping(self, index=None, doc_type=None, params=None):
204
204
def get_field_mapping (self , index = None , doc_type = None , field = None , params = None ):
205
205
"""
206
206
Retrieve mapping definition of a specific field.
207
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html/ >`_
207
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html>`_
208
208
209
209
:arg index: A comma-separated list of index names; use `_all` or empty
210
210
string for all indices
@@ -220,7 +220,7 @@ def get_field_mapping(self, index=None, doc_type=None, field=None, params=None):
220
220
def delete_mapping (self , index , doc_type , params = None ):
221
221
"""
222
222
Delete a mapping (type) along with its data.
223
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html/ >`_
223
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html>`_
224
224
225
225
:arg index: A comma-separated list of index names; use `_all` for all indices
226
226
:arg doc_type: The name of the document type to delete
@@ -234,7 +234,7 @@ def delete_mapping(self, index, doc_type, params=None):
234
234
def put_alias (self , index , name , body = None , params = None ):
235
235
"""
236
236
Create an alias for a specific index/indices.
237
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
237
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
238
238
239
239
:arg index: The name of the index with an alias
240
240
:arg name: The name of the alias to be created or updated
@@ -250,7 +250,7 @@ def put_alias(self, index, name, body=None, params=None):
250
250
def exists_alias (self , name , index = None , params = None ):
251
251
"""
252
252
Return a boolean indicating whether given alias exists.
253
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
253
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
254
254
255
255
:arg name: A comma-separated list of alias names to return
256
256
:arg index: A comma-separated list of index names to filter aliases
@@ -268,7 +268,7 @@ def exists_alias(self, name, index=None, params=None):
268
268
def get_alias (self , name , index = None , params = None ):
269
269
"""
270
270
Retrieve a specified alias.
271
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
271
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
272
272
273
273
:arg name: A comma-separated list of alias names to return
274
274
:arg index: A comma-separated list of index names to filter aliases
@@ -283,7 +283,7 @@ def get_alias(self, name, index=None, params=None):
283
283
def get_aliases (self , index = None , params = None ):
284
284
"""
285
285
Retrieve specified aliases
286
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
286
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
287
287
288
288
:arg index: A comma-separated list of index names to filter aliases
289
289
:arg timeout: Explicit operation timeout
@@ -296,7 +296,7 @@ def get_aliases(self, index=None, params=None):
296
296
def update_aliases (self , body , params = None ):
297
297
"""
298
298
Update specified aliases.
299
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
299
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
300
300
301
301
:arg body: The definition of `actions` to perform
302
302
:arg master_timeout: Specify timeout for connection to master
@@ -310,7 +310,7 @@ def update_aliases(self, body, params=None):
310
310
def delete_alias (self , index , name , params = None ):
311
311
"""
312
312
Delete specific alias.
313
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html/ >`_
313
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
314
314
315
315
:arg index: The name of the index with an alias
316
316
:arg name: The name of the alias to be deleted
@@ -326,7 +326,7 @@ def put_template(self, name, body, params=None):
326
326
"""
327
327
Create an index template that will automatically be applied to new
328
328
indices created.
329
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html/ >`_
329
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
330
330
331
331
:arg name: The name of the template
332
332
:arg body: The template definition
@@ -343,7 +343,7 @@ def put_template(self, name, body, params=None):
343
343
def get_template (self , name = None , params = None ):
344
344
"""
345
345
Retrieve an index template by its name.
346
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html/ >`_
346
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
347
347
348
348
:arg name: The name of the template
349
349
"""
@@ -355,7 +355,7 @@ def get_template(self, name=None, params=None):
355
355
def delete_template (self , name , params = None ):
356
356
"""
357
357
Delete an index template by its name.
358
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html/ >`_
358
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
359
359
360
360
:arg name: The name of the template
361
361
:arg master_timeout: Specify timeout for connection to master
@@ -369,7 +369,7 @@ def delete_template(self, name, params=None):
369
369
def get_settings (self , index = None , params = None ):
370
370
"""
371
371
Retrieve settings for one or more (or all) indices.
372
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html/ >`_
372
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html>`_
373
373
374
374
:arg index: A comma-separated list of index names; use `_all` or empty
375
375
string to perform the operation on all indices
@@ -382,7 +382,7 @@ def get_settings(self, index=None, params=None):
382
382
def put_settings (self , body , index = None , params = None ):
383
383
"""
384
384
Change specific index level settings in real time.
385
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html/ >`_
385
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html>`_
386
386
387
387
:arg index: A comma-separated list of index names; use `_all` or empty
388
388
string to perform the operation on all indices
@@ -398,7 +398,7 @@ def put_warmer(self, index, name, body, doc_type=None, params=None):
398
398
"""
399
399
Create an index warmer to run registered search requests to warm up the
400
400
index before it is available for search.
401
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html/ >`_
401
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html>`_
402
402
403
403
:arg index: A comma-separated list of index names to register the warmer for;
404
404
use `_all` or empty string to perform the operation on all indices
@@ -416,7 +416,7 @@ def put_warmer(self, index, name, body, doc_type=None, params=None):
416
416
def get_warmer (self , index , doc_type = None , name = None , params = None ):
417
417
"""
418
418
Retreieve an index warmer.
419
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html/ >`_
419
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html>`_
420
420
421
421
:arg index: A comma-separated list of index names to restrict the
422
422
operation; use `_all` to perform the operation on all indices
@@ -431,7 +431,7 @@ def get_warmer(self, index, doc_type=None, name=None, params=None):
431
431
def delete_warmer (self , index , doc_type = None , name = None , params = None ):
432
432
"""
433
433
Delete an index warmer.
434
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html/ >`_
434
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html>`_
435
435
436
436
:arg index: A comma-separated list of index names to register warmer
437
437
for; use `_all` or empty string to perform the operation on all indices
@@ -524,7 +524,7 @@ def segments(self, index=None, params=None):
524
524
def optimize (self , index = None , params = None ):
525
525
"""
526
526
Explicitly optimize one or more indices through an API.
527
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html/ >`_
527
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html>`_
528
528
529
529
:arg index: A comma-separated list of index names; use `_all` or empty
530
530
string to perform the operation on all indices
@@ -574,7 +574,7 @@ def validate_query(self, index=None, doc_type=None, body=None, params=None):
574
574
def clear_cache (self , index = None , params = None ):
575
575
"""
576
576
Clear either all caches or specific cached associated with one ore more indices.
577
- `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html/ >`_
577
+ `<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html>`_
578
578
579
579
:arg index: A comma-separated list of index name to limit the operation
580
580
:arg field_data: Clear field data
0 commit comments