Add pagination extension to monitors (#1633)

* Support page param

* Regenerate client from commit fee86b40 of spec repo

---------

Co-authored-by: Thomas Hervé <thomas.herve@datadoghq.com>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 0a40161

datadog_api_client.v1.api.html

@@ -561,6 +561,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitor_groups" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitor_groups()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitors" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitors()</span></code></a>
@@ -1848,6 +1850,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitor_groups" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitor_groups()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitors" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitors()</span></code></a>
@@ -4144,6 +4148,35 @@ <h1 id="datadog-api-client-v1-api--page-root">datadog_api_client.v1.api<a class=
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination">
+<span class="sig-name descname"><span class="pre">list_monitors_with_pagination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_states</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitor_tags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_downtimes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monitor.Monitor" title="datadog_api_client.v1.model.monitor.Monitor"><span class="pre">Monitor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination" title="Link to this definition">¶</a></dt>
+<dd><p>Get all monitor details.</p>
+<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors" title="datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors"><code class="xref py py-meth docutils literal notranslate"><span class="pre">list_monitors()</span></code></a>, returning all items.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>group_states</strong> (<em>str</em><em>, </em><em>optional</em>) – When specified, shows additional information about the group states.
+Choose one or more from <code class="docutils literal notranslate"><span class="pre">all</span></code> , <code class="docutils literal notranslate"><span class="pre">alert</span></code> , <code class="docutils literal notranslate"><span class="pre">warn</span></code> , and <code class="docutils literal notranslate"><span class="pre">no</span> <span class="pre">data</span></code>.</p></li>
+<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – A string to filter monitors by name.</p></li>
+<li><p><strong>tags</strong> (<em>str</em><em>, </em><em>optional</em>) – A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.
+For example, <code class="docutils literal notranslate"><span class="pre">host:host0</span></code>.</p></li>
+<li><p><strong>monitor_tags</strong> (<em>str</em><em>, </em><em>optional</em>) – A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.
+Tags created in the Datadog UI automatically have the service key prepended. For example, <code class="docutils literal notranslate"><span class="pre">service:my-app</span></code>.</p></li>
+<li><p><strong>with_downtimes</strong> (<em>bool</em><em>, </em><em>optional</em>) – If this argument is set to true, then the returned data includes all current active downtimes for each monitor.</p></li>
+<li><p><strong>id_offset</strong> (<em>int</em><em>, </em><em>optional</em>) – Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty.</p></li>
+<li><p><strong>page</strong> (<em>int</em><em>, </em><em>optional</em>) – The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.</p></li>
+<li><p><strong>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a <code class="docutils literal notranslate"><span class="pre">page_size</span></code> limit. However, if page is specified and <code class="docutils literal notranslate"><span class="pre">page_size</span></code> is not, the argument defaults to 100.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A generator of paginated results.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>collections.abc.Iterable[<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monitor.Monitor" title="datadog_api_client.v1.model.monitor.Monitor">Monitor</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitor_groups">
 <span class="sig-name descname"><span class="pre">search_monitor_groups</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per_page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monitor_group_search_response.MonitorGroupSearchResponse" title="datadog_api_client.v1.model.monitor_group_search_response.MonitorGroupSearchResponse"><span class="pre">MonitorGroupSearchResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitor_groups" title="Link to this definition">¶</a></dt>
 <dd><p>Monitors group search.</p>

datadog_api_client.v1.html

@@ -1149,6 +1149,7 @@ <h1 id="datadog-api-client-v1--page-root">datadog_api_client.v1<a class="headerl
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.delete_monitor"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.delete_monitor()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.get_monitor"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.get_monitor()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.list_monitors_with_pagination()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitor_groups"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitor_groups()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitors"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.search_monitors()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.update_monitor"><code class="docutils literal notranslate"><span class="pre">MonitorsApi.update_monitor()</span></code></a></li>

genindex.html

@@ -17150,6 +17150,8 @@ <h2 id="L">L</h2>
       <li><a href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.downtimes_api.DowntimesApi.list_monitor_downtimes">list_monitor_downtimes() (DowntimesApi method)</a>, <a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.downtimes_api.DowntimesApi.list_monitor_downtimes">[1]</a>
 </li>
       <li><a href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors">list_monitors() (MonitorsApi method)</a>
+</li>
+      <li><a href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors_with_pagination">list_monitors_with_pagination() (MonitorsApi method)</a>
 </li>
       <li><a href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.notebooks_api.NotebooksApi.list_notebooks">list_notebooks() (NotebooksApi method)</a>
 </li>