src/build/html/pyams_content_es.html
changeset 11 ba0b83b57c0c
parent 10 1d12ff3f036a
child 12 f1f1e99a6572
equal deleted inserted replaced
10:1d12ff3f036a 11:ba0b83b57c0c
     1 
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 
       
     5 <html xmlns="http://www.w3.org/1999/xhtml">
       
     6   <head>
       
     7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
       
     8     <title>pyams_content_es package &#8212; PyAMS User Guide 0.1.0 documentation</title>
       
     9     <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
       
    10     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       
    11     <script type="text/javascript">
       
    12       var DOCUMENTATION_OPTIONS = {
       
    13         URL_ROOT:    './',
       
    14         VERSION:     '0.1.0',
       
    15         COLLAPSE_INDEX: false,
       
    16         FILE_SUFFIX: '.html',
       
    17         HAS_SOURCE:  true,
       
    18         SOURCELINK_SUFFIX: '.txt'
       
    19       };
       
    20     </script>
       
    21     <script type="text/javascript" src="_static/jquery.js"></script>
       
    22     <script type="text/javascript" src="_static/underscore.js"></script>
       
    23     <script type="text/javascript" src="_static/doctools.js"></script>
       
    24     <link rel="index" title="Index" href="genindex.html" />
       
    25     <link rel="search" title="Search" href="search.html" />
       
    26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    28 <!--[if lte IE 6]>
       
    29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
       
    30 <![endif]-->
       
    31 
       
    32   </head>
       
    33   <body>
       
    34 
       
    35     <div class="related" role="navigation" aria-label="related navigation">
       
    36       <h3>Navigation</h3>
       
    37       <ul>
       
    38         <li class="right" style="margin-right: 10px">
       
    39           <a href="genindex.html" title="General Index"
       
    40              accesskey="I">index</a></li>
       
    41         <li class="right" >
       
    42           <a href="py-modindex.html" title="Python Module Index"
       
    43              >modules</a> |</li>
       
    44         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
    45       </ul>
       
    46     </div>  
       
    47 
       
    48     <div class="document">
       
    49       <div class="documentwrapper">
       
    50         <div class="bodywrapper">
       
    51           <div class="body" role="main">
       
    52             
       
    53   <div class="section" id="pyams-content-es-package">
       
    54 <h1>pyams_content_es package<a class="headerlink" href="#pyams-content-es-package" title="Permalink to this headline">¶</a></h1>
       
    55 <div class="section" id="subpackages">
       
    56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
       
    57 <div class="toctree-wrapper compound">
       
    58 <ul>
       
    59 <li class="toctree-l1"><a class="reference internal" href="pyams_content_es.component.html">pyams_content_es.component package</a><ul>
       
    60 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#submodules">Submodules</a></li>
       
    61 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.extfile">pyams_content_es.component.extfile module</a></li>
       
    62 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.gallery">pyams_content_es.component.gallery module</a></li>
       
    63 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.paragraph">pyams_content_es.component.paragraph module</a></li>
       
    64 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.theme">pyams_content_es.component.theme module</a></li>
       
    65 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.view">pyams_content_es.component.view module</a></li>
       
    66 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.workflow">pyams_content_es.component.workflow module</a></li>
       
    67 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component">Module contents</a></li>
       
    68 </ul>
       
    69 </li>
       
    70 <li class="toctree-l1"><a class="reference internal" href="pyams_content_es.interfaces.html">pyams_content_es.interfaces package</a><ul>
       
    71 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.interfaces.html#module-pyams_content_es.interfaces">Module contents</a></li>
       
    72 </ul>
       
    73 </li>
       
    74 <li class="toctree-l1"><a class="reference internal" href="pyams_content_es.scripts.html">pyams_content_es.scripts package</a><ul>
       
    75 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#submodules">Submodules</a></li>
       
    76 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#module-pyams_content_es.scripts.index">pyams_content_es.scripts.index module</a></li>
       
    77 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#module-pyams_content_es.scripts">Module contents</a></li>
       
    78 </ul>
       
    79 </li>
       
    80 <li class="toctree-l1"><a class="reference internal" href="pyams_content_es.tests.html">pyams_content_es.tests package</a><ul>
       
    81 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#submodules">Submodules</a></li>
       
    82 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests.test_utilsdocs">pyams_content_es.tests.test_utilsdocs module</a></li>
       
    83 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests.test_utilsdocstrings">pyams_content_es.tests.test_utilsdocstrings module</a></li>
       
    84 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests">Module contents</a></li>
       
    85 </ul>
       
    86 </li>
       
    87 <li class="toctree-l1"><a class="reference internal" href="pyams_content_es.zmi.html">pyams_content_es.zmi package</a><ul>
       
    88 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#submodules">Submodules</a></li>
       
    89 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#module-pyams_content_es.zmi.test">pyams_content_es.zmi.test module</a></li>
       
    90 <li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#module-pyams_content_es.zmi">Module contents</a></li>
       
    91 </ul>
       
    92 </li>
       
    93 </ul>
       
    94 </div>
       
    95 </div>
       
    96 <div class="section" id="submodules">
       
    97 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    98 </div>
       
    99 <div class="section" id="module-pyams_content_es.document">
       
   100 <span id="pyams-content-es-document-module"></span><h2>pyams_content_es.document module<a class="headerlink" href="#module-pyams_content_es.document" title="Permalink to this headline">¶</a></h2>
       
   101 <dl class="class">
       
   102 <dt id="pyams_content_es.document.ElasticMixin">
       
   103 <em class="property">class </em><code class="descclassname">pyams_content_es.document.</code><code class="descname">ElasticMixin</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin" title="Permalink to this definition">¶</a></dt>
       
   104 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyramid_es.mixin.ElasticMixin</span></code></p>
       
   105 <p>ElasticSearch base mixin class</p>
       
   106 <dl class="method">
       
   107 <dt id="pyams_content_es.document.ElasticMixin.elastic_document">
       
   108 <code class="descname">elastic_document</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.elastic_document" title="Permalink to this definition">¶</a></dt>
       
   109 <dd></dd></dl>
       
   110 
       
   111 <dl class="method">
       
   112 <dt id="pyams_content_es.document.ElasticMixin.elastic_mapping">
       
   113 <code class="descname">elastic_mapping</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.elastic_mapping" title="Permalink to this definition">¶</a></dt>
       
   114 <dd></dd></dl>
       
   115 
       
   116 <dl class="attribute">
       
   117 <dt id="pyams_content_es.document.ElasticMixin.id">
       
   118 <code class="descname">id</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.id" title="Permalink to this definition">¶</a></dt>
       
   119 <dd></dd></dl>
       
   120 
       
   121 <dl class="attribute">
       
   122 <dt id="pyams_content_es.document.ElasticMixin.internal_id">
       
   123 <code class="descname">internal_id</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.internal_id" title="Permalink to this definition">¶</a></dt>
       
   124 <dd></dd></dl>
       
   125 
       
   126 </dd></dl>
       
   127 
       
   128 <dl class="function">
       
   129 <dt id="pyams_content_es.document.WfSharedContentIndexInfo">
       
   130 <code class="descclassname">pyams_content_es.document.</code><code class="descname">WfSharedContentIndexInfo</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.WfSharedContentIndexInfo" title="Permalink to this definition">¶</a></dt>
       
   131 <dd></dd></dl>
       
   132 
       
   133 </div>
       
   134 <div class="section" id="module-pyams_content_es.include">
       
   135 <span id="pyams-content-es-include-module"></span><h2>pyams_content_es.include module<a class="headerlink" href="#module-pyams_content_es.include" title="Permalink to this headline">¶</a></h2>
       
   136 <dl class="function">
       
   137 <dt id="pyams_content_es.include.handle_new_application">
       
   138 <code class="descclassname">pyams_content_es.include.</code><code class="descname">handle_new_application</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.include.handle_new_application" title="Permalink to this definition">¶</a></dt>
       
   139 <dd><p>Start indexer process when application created</p>
       
   140 </dd></dl>
       
   141 
       
   142 <dl class="function">
       
   143 <dt id="pyams_content_es.include.include_package">
       
   144 <code class="descclassname">pyams_content_es.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.include.include_package" title="Permalink to this definition">¶</a></dt>
       
   145 <dd><p>Pyramid include</p>
       
   146 </dd></dl>
       
   147 
       
   148 </div>
       
   149 <div class="section" id="module-pyams_content_es.index">
       
   150 <span id="pyams-content-es-index-module"></span><h2>pyams_content_es.index module<a class="headerlink" href="#module-pyams_content_es.index" title="Permalink to this headline">¶</a></h2>
       
   151 <dl class="function">
       
   152 <dt id="pyams_content_es.index.handle_added_document">
       
   153 <code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_added_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_added_document" title="Permalink to this definition">¶</a></dt>
       
   154 <dd><p>Handle added document</p>
       
   155 </dd></dl>
       
   156 
       
   157 <dl class="function">
       
   158 <dt id="pyams_content_es.index.handle_modified_document">
       
   159 <code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_modified_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_modified_document" title="Permalink to this definition">¶</a></dt>
       
   160 <dd><p>Handle modified document</p>
       
   161 </dd></dl>
       
   162 
       
   163 <dl class="function">
       
   164 <dt id="pyams_content_es.index.handle_removed_document">
       
   165 <code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_removed_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_removed_document" title="Permalink to this definition">¶</a></dt>
       
   166 <dd><p>Handle removed document</p>
       
   167 </dd></dl>
       
   168 
       
   169 <dl class="function">
       
   170 <dt id="pyams_content_es.index.index_document">
       
   171 <code class="descclassname">pyams_content_es.index.</code><code class="descname">index_document</code><span class="sig-paren">(</span><em>status</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.index_document" title="Permalink to this definition">¶</a></dt>
       
   172 <dd></dd></dl>
       
   173 
       
   174 <dl class="function">
       
   175 <dt id="pyams_content_es.index.unindex_document">
       
   176 <code class="descclassname">pyams_content_es.index.</code><code class="descname">unindex_document</code><span class="sig-paren">(</span><em>status</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.unindex_document" title="Permalink to this definition">¶</a></dt>
       
   177 <dd></dd></dl>
       
   178 
       
   179 </div>
       
   180 <div class="section" id="module-pyams_content_es.process">
       
   181 <span id="pyams-content-es-process-module"></span><h2>pyams_content_es.process module<a class="headerlink" href="#module-pyams_content_es.process" title="Permalink to this headline">¶</a></h2>
       
   182 <dl class="class">
       
   183 <dt id="pyams_content_es.process.BaseIndexerProcess">
       
   184 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">BaseIndexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess" title="Permalink to this definition">¶</a></dt>
       
   185 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">multiprocessing.context.Process</span></code></p>
       
   186 <p>Base indexer process</p>
       
   187 <dl class="method">
       
   188 <dt id="pyams_content_es.process.BaseIndexerProcess.run">
       
   189 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess.run" title="Permalink to this definition">¶</a></dt>
       
   190 <dd></dd></dl>
       
   191 
       
   192 <dl class="method">
       
   193 <dt id="pyams_content_es.process.BaseIndexerProcess.update_index">
       
   194 <code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
       
   195 <dd><p>Update index</p>
       
   196 </dd></dl>
       
   197 
       
   198 </dd></dl>
       
   199 
       
   200 <dl class="class">
       
   201 <dt id="pyams_content_es.process.ContentIndexerHandler">
       
   202 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerHandler</code><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler" title="Permalink to this definition">¶</a></dt>
       
   203 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   204 <p>Content indexer handler</p>
       
   205 <dl class="method">
       
   206 <dt id="pyams_content_es.process.ContentIndexerHandler.index">
       
   207 <code class="descname">index</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.index" title="Permalink to this definition">¶</a></dt>
       
   208 <dd></dd></dl>
       
   209 
       
   210 <dl class="method">
       
   211 <dt id="pyams_content_es.process.ContentIndexerHandler.test">
       
   212 <code class="descname">test</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.test" title="Permalink to this definition">¶</a></dt>
       
   213 <dd></dd></dl>
       
   214 
       
   215 <dl class="method">
       
   216 <dt id="pyams_content_es.process.ContentIndexerHandler.unindex">
       
   217 <code class="descname">unindex</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.unindex" title="Permalink to this definition">¶</a></dt>
       
   218 <dd></dd></dl>
       
   219 
       
   220 </dd></dl>
       
   221 
       
   222 <dl class="class">
       
   223 <dt id="pyams_content_es.process.ContentIndexerMessageHandler">
       
   224 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerMessageHandler</code><span class="sig-paren">(</span><em>process</em>, <em>stream</em>, <em>stop</em>, <em>handler=None</em>, <em>json_load=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerMessageHandler" title="Permalink to this definition">¶</a></dt>
       
   225 <dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.handler.ZMQMessageHandler" title="pyams_zmq.handler.ZMQMessageHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.handler.ZMQMessageHandler</span></code></a></p>
       
   226 <p>Content indexer message handler</p>
       
   227 <dl class="attribute">
       
   228 <dt id="pyams_content_es.process.ContentIndexerMessageHandler.handler">
       
   229 <code class="descname">handler</code><a class="headerlink" href="#pyams_content_es.process.ContentIndexerMessageHandler.handler" title="Permalink to this definition">¶</a></dt>
       
   230 <dd><p>alias of <a class="reference internal" href="#pyams_content_es.process.ContentIndexerHandler" title="pyams_content_es.process.ContentIndexerHandler"><code class="xref py py-class docutils literal"><span class="pre">ContentIndexerHandler</span></code></a></p>
       
   231 </dd></dl>
       
   232 
       
   233 </dd></dl>
       
   234 
       
   235 <dl class="class">
       
   236 <dt id="pyams_content_es.process.ContentIndexerProcess">
       
   237 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerProcess</code><span class="sig-paren">(</span><em>zmq_address</em>, <em>handler</em>, <em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerProcess" title="Permalink to this definition">¶</a></dt>
       
   238 <dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.process.ZMQProcess" title="pyams_zmq.process.ZMQProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.process.ZMQProcess</span></code></a></p>
       
   239 <p>Content indexer ZMQ process</p>
       
   240 </dd></dl>
       
   241 
       
   242 <dl class="class">
       
   243 <dt id="pyams_content_es.process.IndexerProcess">
       
   244 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">IndexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerProcess" title="Permalink to this definition">¶</a></dt>
       
   245 <dd><p>Bases: <a class="reference internal" href="#pyams_content_es.process.BaseIndexerProcess" title="pyams_content_es.process.BaseIndexerProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_content_es.process.BaseIndexerProcess</span></code></a></p>
       
   246 <p>Content indexer process</p>
       
   247 <dl class="method">
       
   248 <dt id="pyams_content_es.process.IndexerProcess.update_index">
       
   249 <code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
       
   250 <dd></dd></dl>
       
   251 
       
   252 </dd></dl>
       
   253 
       
   254 <dl class="class">
       
   255 <dt id="pyams_content_es.process.IndexerThread">
       
   256 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">IndexerThread</code><span class="sig-paren">(</span><em>process</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerThread" title="Permalink to this definition">¶</a></dt>
       
   257 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></code></p>
       
   258 <p>Content indexer thread</p>
       
   259 <dl class="method">
       
   260 <dt id="pyams_content_es.process.IndexerThread.run">
       
   261 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerThread.run" title="Permalink to this definition">¶</a></dt>
       
   262 <dd></dd></dl>
       
   263 
       
   264 </dd></dl>
       
   265 
       
   266 <dl class="class">
       
   267 <dt id="pyams_content_es.process.UnindexerProcess">
       
   268 <em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">UnindexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.UnindexerProcess" title="Permalink to this definition">¶</a></dt>
       
   269 <dd><p>Bases: <a class="reference internal" href="#pyams_content_es.process.BaseIndexerProcess" title="pyams_content_es.process.BaseIndexerProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_content_es.process.BaseIndexerProcess</span></code></a></p>
       
   270 <p>Content un-indexer process</p>
       
   271 <dl class="method">
       
   272 <dt id="pyams_content_es.process.UnindexerProcess.update_index">
       
   273 <code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.UnindexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
       
   274 <dd></dd></dl>
       
   275 
       
   276 </dd></dl>
       
   277 
       
   278 </div>
       
   279 <div class="section" id="module-pyams_content_es.site">
       
   280 <span id="pyams-content-es-site-module"></span><h2>pyams_content_es.site module<a class="headerlink" href="#module-pyams_content_es.site" title="Permalink to this headline">¶</a></h2>
       
   281 <dl class="class">
       
   282 <dt id="pyams_content_es.site.ContentIndexerGenerationsChecker">
       
   283 <em class="property">class </em><code class="descclassname">pyams_content_es.site.</code><code class="descname">ContentIndexerGenerationsChecker</code><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker" title="Permalink to this definition">¶</a></dt>
       
   284 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   285 <p>Content indexer utility generations checker</p>
       
   286 <dl class="method">
       
   287 <dt id="pyams_content_es.site.ContentIndexerGenerationsChecker.evolve">
       
   288 <code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt>
       
   289 <dd><p>Check for required utilities</p>
       
   290 </dd></dl>
       
   291 
       
   292 <dl class="attribute">
       
   293 <dt id="pyams_content_es.site.ContentIndexerGenerationsChecker.generation">
       
   294 <code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt>
       
   295 <dd></dd></dl>
       
   296 
       
   297 </dd></dl>
       
   298 
       
   299 <dl class="function">
       
   300 <dt id="pyams_content_es.site.handle_new_local_site">
       
   301 <code class="descclassname">pyams_content_es.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt>
       
   302 <dd><p>Create a new indexer utility when a site is created</p>
       
   303 </dd></dl>
       
   304 
       
   305 <dl class="function">
       
   306 <dt id="pyams_content_es.site.site_index">
       
   307 <code class="descclassname">pyams_content_es.site.</code><code class="descname">site_index</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.site_index" title="Permalink to this definition">¶</a></dt>
       
   308 <dd><p>Index all site contents in ElasticSearch</p>
       
   309 </dd></dl>
       
   310 
       
   311 </div>
       
   312 <div class="section" id="module-pyams_content_es.utility">
       
   313 <span id="pyams-content-es-utility-module"></span><h2>pyams_content_es.utility module<a class="headerlink" href="#module-pyams_content_es.utility" title="Permalink to this headline">¶</a></h2>
       
   314 <dl class="class">
       
   315 <dt id="pyams_content_es.utility.ContentIndexerUtility">
       
   316 <em class="property">class </em><code class="descclassname">pyams_content_es.utility.</code><code class="descname">ContentIndexerUtility</code><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility" title="Permalink to this definition">¶</a></dt>
       
   317 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
       
   318 <p>Content indexer utility</p>
       
   319 <dl class="method">
       
   320 <dt id="pyams_content_es.utility.ContentIndexerUtility.index_document">
       
   321 <code class="descname">index_document</code><span class="sig-paren">(</span><em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.index_document" title="Permalink to this definition">¶</a></dt>
       
   322 <dd><p>Send index request for given document</p>
       
   323 </dd></dl>
       
   324 
       
   325 <dl class="method">
       
   326 <dt id="pyams_content_es.utility.ContentIndexerUtility.test_process">
       
   327 <code class="descname">test_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.test_process" title="Permalink to this definition">¶</a></dt>
       
   328 <dd><p>Send test request to indexer process</p>
       
   329 </dd></dl>
       
   330 
       
   331 <dl class="method">
       
   332 <dt id="pyams_content_es.utility.ContentIndexerUtility.unindex_document">
       
   333 <code class="descname">unindex_document</code><span class="sig-paren">(</span><em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.unindex_document" title="Permalink to this definition">¶</a></dt>
       
   334 <dd><p>Send unindex request for given document</p>
       
   335 </dd></dl>
       
   336 
       
   337 <dl class="attribute">
       
   338 <dt id="pyams_content_es.utility.ContentIndexerUtility.zodb_name">
       
   339 <code class="descname">zodb_name</code><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.zodb_name" title="Permalink to this definition">¶</a></dt>
       
   340 <dd><p>Computed attributes based on schema fields</p>
       
   341 <p>Field properties provide default values, data validation and error messages
       
   342 based on data found in field meta-data.</p>
       
   343 <p>Note that FieldProperties cannot be used with slots. They can only
       
   344 be used for attributes stored in instance dictionaries.</p>
       
   345 </dd></dl>
       
   346 
       
   347 </dd></dl>
       
   348 
       
   349 </div>
       
   350 <div class="section" id="module-pyams_content_es">
       
   351 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content_es" title="Permalink to this headline">¶</a></h2>
       
   352 <dl class="function">
       
   353 <dt id="pyams_content_es.includeme">
       
   354 <code class="descclassname">pyams_content_es.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.includeme" title="Permalink to this definition">¶</a></dt>
       
   355 <dd><p>Pyramid include</p>
       
   356 </dd></dl>
       
   357 
       
   358 </div>
       
   359 </div>
       
   360 
       
   361 
       
   362           </div>
       
   363         </div>
       
   364       </div>
       
   365       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
   366         <div class="sphinxsidebarwrapper">
       
   367   <h3><a href="index.html">Table Of Contents</a></h3>
       
   368   <ul>
       
   369 <li><a class="reference internal" href="#">pyams_content_es package</a><ul>
       
   370 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
       
   371 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
   372 <li><a class="reference internal" href="#module-pyams_content_es.document">pyams_content_es.document module</a></li>
       
   373 <li><a class="reference internal" href="#module-pyams_content_es.include">pyams_content_es.include module</a></li>
       
   374 <li><a class="reference internal" href="#module-pyams_content_es.index">pyams_content_es.index module</a></li>
       
   375 <li><a class="reference internal" href="#module-pyams_content_es.process">pyams_content_es.process module</a></li>
       
   376 <li><a class="reference internal" href="#module-pyams_content_es.site">pyams_content_es.site module</a></li>
       
   377 <li><a class="reference internal" href="#module-pyams_content_es.utility">pyams_content_es.utility module</a></li>
       
   378 <li><a class="reference internal" href="#module-pyams_content_es">Module contents</a></li>
       
   379 </ul>
       
   380 </li>
       
   381 </ul>
       
   382 
       
   383 <div id="searchbox" style="display: none" role="search">
       
   384   <h3>Quick search</h3>
       
   385     <form class="search" action="search.html" method="get">
       
   386       <div><input type="text" name="q" /></div>
       
   387       <div><input type="submit" value="Go" /></div>
       
   388       <input type="hidden" name="check_keywords" value="yes" />
       
   389       <input type="hidden" name="area" value="default" />
       
   390     </form>
       
   391 </div>
       
   392 <script type="text/javascript">$('#searchbox').show(0);</script>
       
   393         </div>
       
   394       </div>
       
   395       <div class="clearer"></div>
       
   396     </div>
       
   397     <div class="related" role="navigation" aria-label="related navigation">
       
   398       <h3>Navigation</h3>
       
   399       <ul>
       
   400         <li class="right" style="margin-right: 10px">
       
   401           <a href="genindex.html" title="General Index"
       
   402              >index</a></li>
       
   403         <li class="right" >
       
   404           <a href="py-modindex.html" title="Python Module Index"
       
   405              >modules</a> |</li>
       
   406         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
   407       </ul>
       
   408     </div>
       
   409     <div class="footer" role="contentinfo">
       
   410         &#169; Copyright 2017, Thierry Florac.
       
   411       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
       
   412     </div>
       
   413   </body>
       
   414 </html>