File: helpers.rst

package info (click to toggle)
elasticsearch-curator 9.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,740 kB
  • sloc: python: 18,836; makefile: 159; sh: 156
file content (143 lines) | stat: -rw-r--r-- 2,202 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.. _helpers:

Helpers
#######

.. _helpers_date_ops:

Date Ops
========

.. py:module:: curator.helpers.date_ops

.. autoclass:: TimestringSearch
   :members:
   :undoc-members:
   :show-inheritance:

.. autofunction:: absolute_date_range

.. autofunction:: date_range

.. autofunction:: datetime_to_epoch

.. autofunction:: fix_epoch

.. autofunction:: get_date_regex

.. autofunction:: get_datemath

.. autofunction:: get_datetime

.. autofunction:: get_point_of_reference

.. autofunction:: get_unit_count_from_name

.. autofunction:: handle_iso_week_number

.. autofunction:: isdatemath

.. autofunction:: parse_date_pattern

.. autofunction:: parse_datemath


.. _helpers_getters:

Getters
=======

.. py:module:: curator.helpers.getters

.. autofunction:: byte_size

.. autofunction:: get_alias_actions

.. autofunction:: get_data_tiers

.. autofunction:: get_indices

.. autofunction:: get_repository

.. autofunction:: get_snapshot

.. autofunction:: get_snapshot_data

.. autofunction:: get_tier_preference

.. autofunction:: get_write_index

.. autofunction:: index_size

.. autofunction:: name_to_node_id

.. autofunction:: node_id_to_name

.. autofunction:: node_roles

.. autofunction:: single_data_path

.. _helpers_testers:

Testers
=======

.. py:module:: curator.helpers.testers

.. autofunction:: ilm_policy_check

.. autofunction:: repository_exists

.. autofunction:: rollable_alias

.. autofunction:: snapshot_running

.. autofunction:: validate_actions

.. autofunction:: validate_filters

.. autofunction:: verify_client_object

.. autofunction:: verify_repository

.. autofunction:: verify_snapshot_list

.. _helpers_utils:

Utils
=====

.. py:module:: curator.helpers.utils

.. autofunction:: chunk_index_list

.. autofunction:: report_failure

.. autofunction:: show_dry_run

.. autofunction:: to_csv

.. autofunction:: multitarget_fix

.. autofunction:: regex_loop

.. autofunction:: multitarget_match

.. _helpers_waiters:

Waiters
=======

.. py:module:: curator.helpers.waiters

.. autofunction:: health_check

.. autofunction:: relocate_check

.. autofunction:: restore_check

.. autofunction:: snapshot_check

.. autofunction:: task_check

.. autofunction:: wait_for_it