1
2
3[[Elasticsearch_Namespaces_SlmNamespace]]
4=== Elasticsearch\Namespaces\SlmNamespace
5
6
7
8Class SlmNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_SlmNamespacedeleteLifecycle_deleteLifecycle,`deleteLifecycle()`>>
22* <<Elasticsearch_Namespaces_SlmNamespaceexecuteLifecycle_executeLifecycle,`executeLifecycle()`>>
23* <<Elasticsearch_Namespaces_SlmNamespaceexecuteRetention_executeRetention,`executeRetention()`>>
24* <<Elasticsearch_Namespaces_SlmNamespacegetLifecycle_getLifecycle,`getLifecycle()`>>
25* <<Elasticsearch_Namespaces_SlmNamespacegetStats_getStats,`getStats()`>>
26* <<Elasticsearch_Namespaces_SlmNamespacegetStatus_getStatus,`getStatus()`>>
27* <<Elasticsearch_Namespaces_SlmNamespaceputLifecycle_putLifecycle,`putLifecycle()`>>
28* <<Elasticsearch_Namespaces_SlmNamespacestart_start,`start()`>>
29* <<Elasticsearch_Namespaces_SlmNamespacestop_stop,`stop()`>>
30
31
32
33[[Elasticsearch_Namespaces_SlmNamespacedeleteLifecycle_deleteLifecycle]]
34.`deleteLifecycle(array $params = [])`
35****
36[source,php]
37----
38/*
39$params['policy_id'] = (string) The id of the snapshot lifecycle policy to remove
40*/
41----
42****
43
44
45
46[[Elasticsearch_Namespaces_SlmNamespaceexecuteLifecycle_executeLifecycle]]
47.`executeLifecycle(array $params = [])`
48****
49[source,php]
50----
51/*
52$params['policy_id'] = (string) The id of the snapshot lifecycle policy to be executed
53*/
54----
55****
56
57
58
59[[Elasticsearch_Namespaces_SlmNamespaceexecuteRetention_executeRetention]]
60.`executeRetention(array $params = [])`
61****
62[source,php]
63----
64/*
65*/
66----
67****
68
69
70
71[[Elasticsearch_Namespaces_SlmNamespacegetLifecycle_getLifecycle]]
72.`getLifecycle(array $params = [])`
73****
74[source,php]
75----
76/*
77$params['policy_id'] = (list) Comma-separated list of snapshot lifecycle policies to retrieve
78*/
79----
80****
81
82
83
84[[Elasticsearch_Namespaces_SlmNamespacegetStats_getStats]]
85.`getStats(array $params = [])`
86****
87[source,php]
88----
89/*
90*/
91----
92****
93
94
95
96[[Elasticsearch_Namespaces_SlmNamespacegetStatus_getStatus]]
97.`getStatus(array $params = [])`
98****
99[source,php]
100----
101/*
102*/
103----
104****
105
106
107
108[[Elasticsearch_Namespaces_SlmNamespaceputLifecycle_putLifecycle]]
109.`putLifecycle(array $params = [])`
110****
111[source,php]
112----
113/*
114$params['policy_id'] = (string) The id of the snapshot lifecycle policy
115$params['body']      = (array) The snapshot lifecycle policy definition to register
116*/
117----
118****
119
120
121
122[[Elasticsearch_Namespaces_SlmNamespacestart_start]]
123.`start(array $params = [])`
124****
125[source,php]
126----
127/*
128*/
129----
130****
131
132
133
134[[Elasticsearch_Namespaces_SlmNamespacestop_stop]]
135.`stop(array $params = [])`
136****
137[source,php]
138----
139/*
140*/
141----
142****
143
144
145