/usr/share/doc/python-elasticsearch-curator-doc/html/actionclasses.html is in python-elasticsearch-curator-doc 4.2.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Action Classes — Elasticsearch Curator 4.2.5 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.2.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Elasticsearch Curator 4.2.5 documentation" href="index.html" />
<link rel="next" title="Filter Methods" href="filters.html" />
<link rel="prev" title="Object Classes" href="objectclasses.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="filters.html" title="Filter Methods"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="objectclasses.html" title="Object Classes"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Elasticsearch Curator 4.2.5 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="action-classes">
<span id="actionclasses"></span><h1>Action Classes<a class="headerlink" href="#action-classes" title="Permalink to this headline">¶</a></h1>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">It is important to note that each action has a <cite>do_action()</cite>
method, which accepts no arguments. This is the means by which all
actions are executed.</p>
</div>
<ul class="simple">
<li><a class="reference internal" href="#alias">Alias</a></li>
<li><a class="reference internal" href="#allocation">Allocation</a></li>
<li><a class="reference internal" href="#close">Close</a></li>
<li><a class="reference internal" href="#clusterrouting">ClusterRouting</a></li>
<li><a class="reference internal" href="#deleteindices">DeleteIndices</a></li>
<li><a class="reference internal" href="#deletesnapshots">DeleteSnapshots</a></li>
<li><a class="reference internal" href="#forcemerge">ForceMerge</a></li>
<li><a class="reference internal" href="#open">Open</a></li>
<li><a class="reference internal" href="#replicas">Replicas</a></li>
<li><a class="reference internal" href="#snapshot">Snapshot</a></li>
</ul>
<div class="section" id="alias">
<h2>Alias<a class="headerlink" href="#alias" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Alias">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Alias</code><span class="sig-paren">(</span><em>name=None</em>, <em>extra_settings={}</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the Alias object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The alias name</li>
<li><strong>extra_settings</strong> (<em>dict, representing the settings.</em>) – Extra settings, including filters and routing. For
more information see
<a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html</a></li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Alias.actions">
<code class="descname">actions</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Alias.actions" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of actions to perform. Populated by
<a class="reference internal" href="#curator.actions.Alias.add" title="curator.actions.Alias.add"><code class="xref py py-mod docutils literal"><span class="pre">curator.actions.Alias.add</span></code></a> and
<a class="reference internal" href="#curator.actions.Alias.remove" title="curator.actions.Alias.remove"><code class="xref py py-mod docutils literal"><span class="pre">curator.actions.Alias.remove</span></code></a></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Alias.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>ilo</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Create <cite>add</cite> statements for each index in <cite>ilo</cite> for <cite>alias</cite>, then
append them to <cite>actions</cite>. Add any <cite>extras</cite> that may be there.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Alias.body">
<code class="descname">body</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias.body" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <cite>body</cite> string suitable for use with the <cite>update_aliases</cite> API
call.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Alias.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Alias.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Alias.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the API call <cite>update_aliases</cite> with the results of <cite>body()</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Alias.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Alias.extra_settings">
<code class="descname">extra_settings</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Alias.extra_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Any extra things to add to the alias, like filters, or routing.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Alias.name">
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Alias.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable
The strftime parsed version of <cite>name</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Alias.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>ilo</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Alias.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Create <cite>remove</cite> statements for each index in <cite>ilo</cite> for <cite>alias</cite>,
then append them to <cite>actions</cite>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="allocation">
<h2>Allocation<a class="headerlink" href="#allocation" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Allocation">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Allocation</code><span class="sig-paren">(</span><em>ilo</em>, <em>key=None</em>, <em>value=None</em>, <em>allocation_type='require'</em>, <em>wait_for_completion=False</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Allocation" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>key</strong> – An arbitrary metadata attribute key. Must match the key
assigned to at least some of your nodes to have any effect.</li>
<li><strong>value</strong> – An arbitrary metadata attribute value. Must correspond to
values associated with <cite>key</cite> assigned to at least some of your nodes
to have any effect.</li>
<li><strong>allocation_type</strong> – Type of allocation to apply. Default is <cite>require</cite></li>
<li><strong>wait_for_completion</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Wait (or not) for the operation
to complete before returning. (default: <cite>False</cite>)</li>
<li><strong>timeout</strong> – Number of seconds to <cite>wait_for_completion</cite></li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">See:
<a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-allocation-filtering.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-allocation-filtering.html</a></p>
</div>
<dl class="attribute">
<dt id="curator.actions.Allocation.bkey">
<code class="descname">bkey</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Allocation.bkey" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Populated at instance creation time. Value is
<code class="docutils literal"><span class="pre">index.routing.allocation.</span></code> <cite>allocation_type</cite> <code class="docutils literal"><span class="pre">.</span></code> <cite>key</cite> <code class="docutils literal"><span class="pre">.</span></code> <cite>value</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Allocation.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Allocation.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Allocation.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Allocation.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Change allocation settings for indices in <cite>index_list.indices</cite> with the
settings in <cite>body</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Allocation.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Allocation.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Allocation.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Allocation.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Allocation.timeout">
<code class="descname">timeout</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Allocation.timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
How long in seconds to <cite>wait_for_completion</cite> before returning with an
exception</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Allocation.wfc">
<code class="descname">wfc</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Allocation.wfc" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>wait_for_completion</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="close">
<h2>Close<a class="headerlink" href="#close" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Close">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Close</code><span class="sig-paren">(</span><em>ilo</em>, <em>delete_aliases=False</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Close" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>delete_aliases</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – If <cite>True</cite>, will delete any associated aliases
before closing indices.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Close.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Close.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Close.delete_aliases">
<code class="descname">delete_aliases</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Close.delete_aliases" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>delete_aliases</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Close.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Close.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Close open indices in <cite>index_list.indices</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Close.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Close.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Close.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Close.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="clusterrouting">
<h2>ClusterRouting<a class="headerlink" href="#clusterrouting" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.ClusterRouting">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">ClusterRouting</code><span class="sig-paren">(</span><em>client</em>, <em>routing_type=None</em>, <em>setting=None</em>, <em>value=None</em>, <em>wait_for_completion=False</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ClusterRouting" title="Permalink to this definition">¶</a></dt>
<dd><p>For now, the cluster routing settings are hardcoded to be <code class="docutils literal"><span class="pre">transient</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>client</strong> – An <a class="reference external" href="http://elasticsearch-py.readthedocs.io/en/2.3.0/api.html#elasticsearch.Elasticsearch" title="(in Elasticsearch v1.6.0)"><code class="xref py py-class docutils literal"><span class="pre">elasticsearch.Elasticsearch</span></code></a> client object</li>
<li><strong>routing_type</strong> – Type of routing to apply. Either <cite>allocation</cite> or
<cite>rebalance</cite></li>
<li><strong>setting</strong> – Currently, the only acceptable value for <cite>setting</cite> is
<code class="docutils literal"><span class="pre">enable</span></code>. This is here in case that changes.</li>
<li><strong>value</strong> – Used only if <cite>setting</cite> is <cite>enable</cite>. Semi-dependent on
<cite>routing_type</cite>. Acceptable values for <cite>allocation</cite> and <cite>rebalance</cite>
are <code class="docutils literal"><span class="pre">all</span></code>, <code class="docutils literal"><span class="pre">primaries</span></code>, and <code class="docutils literal"><span class="pre">none</span></code> (string, not <cite>NoneType</cite>).
If <cite>routing_type</cite> is <cite>allocation</cite>, this can also be
<code class="docutils literal"><span class="pre">new_primaries</span></code>, and if <cite>rebalance</cite>, it can be <code class="docutils literal"><span class="pre">replicas</span></code>.</li>
<li><strong>wait_for_completion</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Wait (or not) for the operation
to complete before returning. (default: <cite>False</cite>)</li>
<li><strong>timeout</strong> – Number of seconds to <cite>wait_for_completion</cite></li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.ClusterRouting.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ClusterRouting.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
An <a class="reference external" href="http://elasticsearch-py.readthedocs.io/en/2.3.0/api.html#elasticsearch.Elasticsearch" title="(in Elasticsearch v1.6.0)"><code class="xref py py-class docutils literal"><span class="pre">elasticsearch.Elasticsearch</span></code></a> client object</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.ClusterRouting.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ClusterRouting.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Change cluster routing settings with the settings in <cite>body</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.ClusterRouting.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ClusterRouting.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.ClusterRouting.timeout">
<code class="descname">timeout</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ClusterRouting.timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
How long in seconds to <cite>wait_for_completion</cite> before returning with an
exception</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.ClusterRouting.wfc">
<code class="descname">wfc</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ClusterRouting.wfc" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>wait_for_completion</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="deleteindices">
<h2>DeleteIndices<a class="headerlink" href="#deleteindices" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.DeleteIndices">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">DeleteIndices</code><span class="sig-paren">(</span><em>ilo</em>, <em>master_timeout=30</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteIndices" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>master_timeout</strong> – Number of seconds to wait for master node response</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.DeleteIndices.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteIndices.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.DeleteIndices.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteIndices.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete indices in <cite>index_list.indices</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.DeleteIndices.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteIndices.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteIndices.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteIndices.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteIndices.master_timeout">
<code class="descname">master_timeout</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteIndices.master_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
String value of <cite>master_timeout</cite> + ‘s’, for seconds.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="deletesnapshots">
<h2>DeleteSnapshots<a class="headerlink" href="#deletesnapshots" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.DeleteSnapshots">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">DeleteSnapshots</code><span class="sig-paren">(</span><em>slo</em>, <em>retry_interval=120</em>, <em>retry_count=3</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteSnapshots" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>slo</strong> – A <a class="reference internal" href="objectclasses.html#curator.snapshotlist.SnapshotList" title="curator.snapshotlist.SnapshotList"><code class="xref py py-class docutils literal"><span class="pre">curator.snapshotlist.SnapshotList</span></code></a> object</li>
<li><strong>retry_interval</strong> – Number of seconds to delay betwen retries. Default:
120 (seconds)</li>
<li><strong>retry_count</strong> – Number of attempts to make. Default: 3</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.DeleteSnapshots.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteSnapshots.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>slo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.DeleteSnapshots.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteSnapshots.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete snapshots in <cite>slo</cite>
Retry up to <cite>retry_count</cite> times, pausing <cite>retry_interval</cite>
seconds between retries.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.DeleteSnapshots.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.DeleteSnapshots.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteSnapshots.repository">
<code class="descname">repository</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteSnapshots.repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The repository name derived from <cite>slo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteSnapshots.retry_count">
<code class="descname">retry_count</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteSnapshots.retry_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>retry_count</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteSnapshots.retry_interval">
<code class="descname">retry_interval</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteSnapshots.retry_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>retry_interval</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.DeleteSnapshots.snapshot_list">
<code class="descname">snapshot_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.DeleteSnapshots.snapshot_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>slo</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="forcemerge">
<h2>ForceMerge<a class="headerlink" href="#forcemerge" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.ForceMerge">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">ForceMerge</code><span class="sig-paren">(</span><em>ilo</em>, <em>max_num_segments=None</em>, <em>delay=0</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ForceMerge" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>max_num_segments</strong> – Number of segments per shard to forceMerge</li>
<li><strong>delay</strong> – Number of seconds to delay between forceMerge operations</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.ForceMerge.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ForceMerge.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.ForceMerge.delay">
<code class="descname">delay</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ForceMerge.delay" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>delay</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.ForceMerge.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ForceMerge.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>forcemerge indices in <cite>index_list.indices</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.ForceMerge.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.ForceMerge.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.ForceMerge.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ForceMerge.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.ForceMerge.max_num_segments">
<code class="descname">max_num_segments</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.ForceMerge.max_num_segments" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>max_num_segments</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="open">
<h2>Open<a class="headerlink" href="#open" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Open">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Open</code><span class="sig-paren">(</span><em>ilo</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Open" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Open.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Open.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Open.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Open.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Open closed indices in <cite>index_list.indices</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Open.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Open.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Open.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Open.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="replicas">
<h2>Replicas<a class="headerlink" href="#replicas" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Replicas">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Replicas</code><span class="sig-paren">(</span><em>ilo</em>, <em>count=None</em>, <em>wait_for_completion=False</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Replicas" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>count</strong> – The count of replicas per shard</li>
<li><strong>wait_for_completion</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Wait (or not) for the operation
to complete before returning. (default: <cite>False</cite>)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Replicas.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Replicas.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Replicas.count">
<code class="descname">count</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Replicas.count" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>count</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Replicas.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Replicas.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the replica count of indices in <cite>index_list.indices</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Replicas.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Replicas.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Replicas.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Replicas.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Replicas.timeout">
<code class="descname">timeout</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Replicas.timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
How long in seconds to <cite>wait_for_completion</cite> before returning with an
exception</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Replicas.wfc">
<code class="descname">wfc</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Replicas.wfc" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>wait_for_completion</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="snapshot">
<h2>Snapshot<a class="headerlink" href="#snapshot" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Snapshot">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Snapshot</code><span class="sig-paren">(</span><em>ilo</em>, <em>repository=None</em>, <em>name=None</em>, <em>ignore_unavailable=False</em>, <em>include_global_state=True</em>, <em>partial=False</em>, <em>wait_for_completion=True</em>, <em>skip_repo_fs_check=False</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Snapshot" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ilo</strong> – A <a class="reference internal" href="objectclasses.html#curator.indexlist.IndexList" title="curator.indexlist.IndexList"><code class="xref py py-class docutils literal"><span class="pre">curator.indexlist.IndexList</span></code></a> object</li>
<li><strong>repository</strong> – The Elasticsearch snapshot repository to use</li>
<li><strong>name</strong> – What to name the snapshot.</li>
<li><strong>wait_for_completion</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Wait (or not) for the operation
to complete before returning. (default: <cite>True</cite>)</li>
<li><strong>ignore_unavailable</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Ignore unavailable shards/indices.
(default: <cite>False</cite>)</li>
<li><strong>include_global_state</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Store cluster global state with snapshot.
(default: <cite>True</cite>)</li>
<li><strong>partial</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Do not fail if primary shard is unavailable. (default:
<cite>False</cite>)</li>
<li><strong>skip_repo_fs_check</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Do not validate write access to repository on
all cluster nodes before proceeding. (default: <cite>False</cite>). Useful for
shared filesystems where intermittent timeouts can affect
validation, but won’t likely affect snapshot success.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Snapshot.body">
<code class="descname">body</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.body" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Populated at instance creation time by calling
<a class="reference internal" href="utilities.html#curator.utils.create_snapshot_body" title="curator.utils.create_snapshot_body"><code class="xref py py-mod docutils literal"><span class="pre">curator.utils.create_snapshot_body</span></code></a> with <cite>ilo.indices</cite> and the
provided arguments: <cite>ignore_unavailable</cite>, <cite>include_global_state</cite>,
<cite>partial</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>ilo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Snapshot.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Snapshot.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Snapshot indices in <cite>index_list.indices</cite>, with options passed.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Snapshot.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Snapshot.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Snapshot.get_state">
<code class="descname">get_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Snapshot.get_state" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the state of the snapshot</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.index_list">
<code class="descname">index_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.index_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>ilo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.name">
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The parsed version of <cite>name</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Snapshot.report_state">
<code class="descname">report_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Snapshot.report_state" title="Permalink to this definition">¶</a></dt>
<dd><p>Log the state of the snapshot</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.repository">
<code class="descname">repository</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>repository</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.skip_repo_fs_check">
<code class="descname">skip_repo_fs_check</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.skip_repo_fs_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>skip_repo_fs_check</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Snapshot.wait_for_completion">
<code class="descname">wait_for_completion</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Snapshot.wait_for_completion" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>wait_for_completion</cite></p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="restore">
<h2>Restore<a class="headerlink" href="#restore" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="curator.actions.Restore">
<em class="property">class </em><code class="descclassname">curator.actions.</code><code class="descname">Restore</code><span class="sig-paren">(</span><em>slo</em>, <em>name=None</em>, <em>indices=None</em>, <em>include_aliases=False</em>, <em>ignore_unavailable=False</em>, <em>include_global_state=True</em>, <em>partial=False</em>, <em>rename_pattern=None</em>, <em>rename_replacement=None</em>, <em>extra_settings={}</em>, <em>wait_for_completion=True</em>, <em>skip_repo_fs_check=False</em><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Restore" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>slo</strong> – A <a class="reference internal" href="objectclasses.html#curator.snapshotlist.SnapshotList" title="curator.snapshotlist.SnapshotList"><code class="xref py py-class docutils literal"><span class="pre">curator.snapshotlist.SnapshotList</span></code></a> object</li>
<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) – Name of the snapshot to restore. If no name is provided, it
will restore the most recent snapshot by age.</li>
<li><strong>indices</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#list" title="(in Python v3.5)"><em>list</em></a>) – A list of indices to restore. If no indices are provided,
it will restore all indices in the snapshot.</li>
<li><strong>include_aliases</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – If set to <cite>True</cite>, restore aliases with the
indices. (default: <cite>False</cite>)</li>
<li><strong>ignore_unavailable</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Ignore unavailable shards/indices.
(default: <cite>False</cite>)</li>
<li><strong>include_global_state</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Store cluster global state with snapshot.
(default: <cite>True</cite>)</li>
<li><strong>partial</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Do not fail if primary shard is unavailable. (default:
<cite>False</cite>)</li>
<li><strong>rename_pattern</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) – A regular expression pattern with one or more
captures, e.g. <code class="docutils literal"><span class="pre">index_(.+)</span></code></li>
<li><strong>rename_replacement</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) – A target index name pattern with <cite>$#</cite> numbered
references to the captures in <code class="docutils literal"><span class="pre">rename_pattern</span></code>, e.g.
<code class="docutils literal"><span class="pre">restored_index_$1</span></code></li>
<li><strong>extra_settings</strong> (<em>dict, representing the settings.</em>) – Extra settings, including shard count and settings
to omit. For more information see
<a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_changing_index_settings_during_restore">https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_changing_index_settings_during_restore</a></li>
<li><strong>wait_for_completion</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Wait (or not) for the operation
to complete before returning. (default: <cite>True</cite>)</li>
<li><strong>skip_repo_fs_check</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – Do not validate write access to repository on
all cluster nodes before proceeding. (default: <cite>False</cite>). Useful for
shared filesystems where intermittent timeouts can affect
validation, but won’t likely affect snapshot success.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="curator.actions.Restore.body">
<code class="descname">body</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.body" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Populated at instance creation time from the other options</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.client">
<code class="descname">client</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.client" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
The Elasticsearch Client object derived from <cite>slo</cite></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Restore.do_action">
<code class="descname">do_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Restore.do_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore indices with options passed.</p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Restore.do_dry_run">
<code class="descname">do_dry_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Restore.do_dry_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Log what the output would be, but take no action.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.name">
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Will use a provided snapshot name, or the most recent snapshot in slo</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.py_rename_replacement">
<code class="descname">py_rename_replacement</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.py_rename_replacement" title="Permalink to this definition">¶</a></dt>
<dd><p>Also an instance variable version of <code class="docutils literal"><span class="pre">rename_replacement</span></code>
but with Java regex group designations of <code class="docutils literal"><span class="pre">$#</span></code>
converted to Python’s <code class="docutils literal"><span class="pre">\\#</span></code> style.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.rename_pattern">
<code class="descname">rename_pattern</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.rename_pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable version of <code class="docutils literal"><span class="pre">rename_pattern</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.rename_replacement">
<code class="descname">rename_replacement</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.rename_replacement" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable version of <code class="docutils literal"><span class="pre">rename_replacement</span></code></p>
</dd></dl>
<dl class="method">
<dt id="curator.actions.Restore.report_state">
<code class="descname">report_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curator.actions.Restore.report_state" title="Permalink to this definition">¶</a></dt>
<dd><p>Log the state of the restore
This should only be done if <code class="docutils literal"><span class="pre">wait_for_completion</span></code> is <cite>True</cite>, and only
after completing the restore.</p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.repository">
<code class="descname">repository</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
<cite>repository</cite> derived from <cite>slo</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.skip_repo_fs_check">
<code class="descname">skip_repo_fs_check</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.skip_repo_fs_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internally accessible copy of <cite>skip_repo_fs_check</cite></p>
</dd></dl>
<dl class="attribute">
<dt id="curator.actions.Restore.snapshot_list">
<code class="descname">snapshot_list</code><em class="property"> = None</em><a class="headerlink" href="#curator.actions.Restore.snapshot_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance variable.
Internal reference to <cite>slo</cite></p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Action Classes</a><ul>
<li><a class="reference internal" href="#alias">Alias</a></li>
<li><a class="reference internal" href="#allocation">Allocation</a></li>
<li><a class="reference internal" href="#close">Close</a></li>
<li><a class="reference internal" href="#clusterrouting">ClusterRouting</a></li>
<li><a class="reference internal" href="#deleteindices">DeleteIndices</a></li>
<li><a class="reference internal" href="#deletesnapshots">DeleteSnapshots</a></li>
<li><a class="reference internal" href="#forcemerge">ForceMerge</a></li>
<li><a class="reference internal" href="#open">Open</a></li>
<li><a class="reference internal" href="#replicas">Replicas</a></li>
<li><a class="reference internal" href="#snapshot">Snapshot</a></li>
<li><a class="reference internal" href="#restore">Restore</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="objectclasses.html"
title="previous chapter">Object Classes</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="filters.html"
title="next chapter">Filter Methods</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/actionclasses.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="filters.html" title="Filter Methods"
>next</a> |</li>
<li class="right" >
<a href="objectclasses.html" title="Object Classes"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Elasticsearch Curator 4.2.5 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2017, Elasticsearch.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>
|