Add pagination method for NDM ListDevices. (#2547)

Co-authored-by: ci.datadog-api-spec <[email protected]> 19a5dfa

Author: api-clients-generation-pipeline[bot]

datadog_api_client.v2.api.html

@@ -1603,6 +1603,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_device_user_tags()</span></code></a>
         </li></ul>
             </nav>
@@ -7300,14 +7302,14 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices">
-<span class="sig-name descname"><span class="pre">list_devices</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">page_number</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>, <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>, <em class="sig-param"><span class="n"><span class="pre">filter_tag</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.v2.model.html#datadog_api_client.v2.model.list_devices_response.ListDevicesResponse" title="datadog_api_client.v2.model.list_devices_response.ListDevicesResponse"><span class="pre">ListDevicesResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">list_devices</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">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>, <em class="sig-param"><span class="n"><span class="pre">page_number</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>, <em class="sig-param"><span class="n"><span class="pre">filter_tag</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.v2.model.html#datadog_api_client.v2.model.list_devices_response.ListDevicesResponse" title="datadog_api_client.v2.model.list_devices_response.ListDevicesResponse"><span class="pre">ListDevicesResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices" title="Link to this definition">¶</a></dt>
 <dd><p>Get the list of devices.</p>
 <p>Get the list of devices.</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>page_number</strong> (<em>int</em><em>, </em><em>optional</em>) – The page number to fetch.</p></li>
-<li><p><strong>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of devices to return per page.</p></li>
+<li><p><strong>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – Size for a given page. The maximum allowed value is 100.</p></li>
+<li><p><strong>page_number</strong> (<em>int</em><em>, </em><em>optional</em>) – Specific page number to return.</p></li>
 <li><p><strong>sort</strong> (<em>str</em><em>, </em><em>optional</em>) – The field to sort the devices by.</p></li>
 <li><p><strong>filter_tag</strong> (<em>str</em><em>, </em><em>optional</em>) – Filter devices by tag.</p></li>
 </ul>
@@ -7318,6 +7320,28 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination">
+<span class="sig-name descname"><span class="pre">list_devices_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">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>, <em class="sig-param"><span class="n"><span class="pre">page_number</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>, <em class="sig-param"><span class="n"><span class="pre">filter_tag</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"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.devices_list_data.DevicesListData" title="datadog_api_client.v2.model.devices_list_data.DevicesListData"><span class="pre">DevicesListData</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination" title="Link to this definition">¶</a></dt>
+<dd><p>Get the list of devices.</p>
+<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices" title="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices"><code class="xref py py-meth docutils literal notranslate"><span class="pre">list_devices()</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>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – Size for a given page. The maximum allowed value is 100.</p></li>
+<li><p><strong>page_number</strong> (<em>int</em><em>, </em><em>optional</em>) – Specific page number to return.</p></li>
+<li><p><strong>sort</strong> (<em>str</em><em>, </em><em>optional</em>) – The field to sort the devices by.</p></li>
+<li><p><strong>filter_tag</strong> (<em>str</em><em>, </em><em>optional</em>) – Filter devices by tag.</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.v2.model.html#datadog_api_client.v2.model.devices_list_data.DevicesListData" title="datadog_api_client.v2.model.devices_list_data.DevicesListData">DevicesListData</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags">
 <span class="sig-name descname"><span class="pre">update_device_user_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_tags_response.ListTagsResponse" title="datadog_api_client.v2.model.list_tags_response.ListTagsResponse"><span class="pre">ListTagsResponse</span></a></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.v2.model.html#datadog_api_client.v2.model.list_tags_response.ListTagsResponse" title="datadog_api_client.v2.model.list_tags_response.ListTagsResponse"><span class="pre">ListTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags" title="Link to this definition">¶</a></dt>
 <dd><p>Update the tags for a device.</p>

datadog_api_client.v2.html

@@ -1390,6 +1390,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.get_interfaces"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.get_interfaces()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_device_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_device_user_tags()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices_with_pagination()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_device_user_tags()</span></code></a></li>
 </ul>
 </li>

genindex.html

@@ -29607,6 +29607,8 @@ <h2 id="L">L</h2>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_device_user_tags">list_device_user_tags() (NetworkDeviceMonitoringApi method)</a>
 </li>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices">list_devices() (NetworkDeviceMonitoringApi method)</a>
+</li>
+      <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination">list_devices_with_pagination() (NetworkDeviceMonitoringApi method)</a>
 </li>
       <li><a href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.downtimes_api.DowntimesApi.list_downtimes">list_downtimes() (DowntimesApi method)</a>, <a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.downtimes_api.DowntimesApi.list_downtimes">[1]</a>
 </li>