use max_results instead of paging

daniel-sanche · Oct 6, 2021 · Aug 3, 2021 · Aug 3, 2021 · Aug 3, 2021 · Aug 4, 2021
commit 172a2eefb73491e04a13028fa8d610460a4eb17b
diff --git a/google/cloud/logging_v2/_gapic.py b/google/cloud/logging_v2/_gapic.py
@@ -49,8 +49,7 @@ def list_entries(
         *,
         filter_=None,
         order_by=None,
-        page_size=None,
-        page_token=None,
+        max_results=None,
     ):
         """Return a page of log entry resources.
 
@@ -69,11 +68,6 @@ def list_entries(
                 https://cloud.google.com/logging/docs/view/advanced_filters
             order_by (str) One of :data:`~logging_v2.ASCENDING`
                 or :data:`~logging_v2.DESCENDING`.
-            page_size (int): maximum number of entries to return, If not passed,
-                defaults to a value set by the API.
-            page_token (str): opaque marker for the next "page" of entries. If not
-                passed, the API will return the first page of
-                entries.
 
         Returns:
             Iterator[~logging_v2.LogEntry]
@@ -84,8 +78,7 @@ def list_entries(
             resource_names=resource_names,
             filter=filter_,
             order_by=order_by,
-            page_size=page_size,
-            page_token=page_token,
+            page_size=None,
         )
 
         response = self._gapic_api.list_log_entries(request=request)
@@ -97,9 +90,13 @@ def list_entries(
         loggers = {}
 
         def log_entries_pager(page_iter):
+            i = 0
             for page in page_iter:
+                if max_results is not None and i >= max_results:
+                    break
                 log_entry_dict = _parse_log_entry(LogEntryPB.pb(page))
                 yield entry_from_resource(log_entry_dict, self._client, loggers=loggers)
+                i += 1
 
         return log_entries_pager(page_iter)
 

diff --git a/google/cloud/logging_v2/_http.py b/google/cloud/logging_v2/_http.py
@@ -74,8 +74,7 @@ def list_entries(
         *,
         filter_=None,
         order_by=None,
-        page_size=None,
-        page_token=None,
+        max_results=None,
     ):
         """Return a page of log entry resources.
 
@@ -94,11 +93,6 @@ def list_entries(
                 https://cloud.google.com/logging/docs/view/advanced_filters
             order_by (str) One of :data:`~logging_v2.ASCENDING`
                 or :data:`~logging_v2.DESCENDING`.
-            page_size (int): maximum number of entries to return, If not passed,
-                defaults to a value set by the API.
-            page_token (str): opaque marker for the next "page" of entries. If not
-                passed, the API will return the first page of
-                entries.
 
         Returns:
             Iterator[~logging_v2.LogEntry]
@@ -111,9 +105,6 @@ def list_entries(
         if order_by is not None:
             extra_params["orderBy"] = order_by
 
-        if page_size is not None:
-            extra_params["pageSize"] = page_size
-
         path = "/entries:list"
         # We attach a mutable loggers dictionary so that as Logger
         # objects are created by entry_from_resource, they can be
@@ -126,15 +117,18 @@ def list_entries(
             path=path,
             item_to_value=item_to_value,
             items_key="entries",
-            page_token=page_token,
             extra_params=extra_params,
         )
         # This method uses POST to make a read-only request.
         iterator._HTTP_METHOD = "POST"
 
         def log_entries_pager(page_iter):
+            i = 0
             for page in page_iter:
+                if max_results is not None and i >= max_results:
+                    break
                 yield page
+                i += 1
 
         return log_entries_pager(iterator)
 

diff --git a/google/cloud/logging_v2/client.py b/google/cloud/logging_v2/client.py
@@ -204,8 +204,7 @@ def list_entries(
         resource_names=None,
         filter_=None,
         order_by=None,
-        page_size=None,
-        page_token=None,
+        max_results=None,
     ):
         """Return a page of log entry resources.
 
@@ -226,11 +225,10 @@ def list_entries(
                 https://cloud.google.com/logging/docs/view/advanced_filters
             order_by (str) One of :data:`~logging_v2.ASCENDING`
                 or :data:`~logging_v2.DESCENDING`.
-            page_size (int): maximum number of entries to return, If not passed,
-                defaults to a value set by the API.
-            page_token (str): opaque marker for the next "page" of entries. If not
-                passed, the API will return the first page of
-                entries.
+            max_results (Optional[int]):
+                Optional. The maximum number of entries to return.
+                Non-positive values are ignored. Defaults
+                to API unlimited.
 
         Returns:
             Iterator[~logging_v2.LogEntry]
@@ -243,8 +241,7 @@ def list_entries(
             resource_names=resource_names,
             filter_=filter_,
             order_by=order_by,
-            page_size=page_size,
-            page_token=page_token,
+            max_results=max_results,
         )
 
     def sink(self, name, *, filter_=None, destination=None):

diff --git a/google/cloud/logging_v2/logger.py b/google/cloud/logging_v2/logger.py
@@ -266,6 +266,7 @@ def list_entries(
         order_by=None,
         page_size=None,
         page_token=None,
+        max_results=None
     ):
         """Return a page of log entries.
 
@@ -289,16 +290,10 @@ def list_entries(
                 By default, a 24 hour filter is applied.
             order_by (Optional[str]): One of :data:`~logging_v2.ASCENDING`
                 or :data:`~logging_v2.DESCENDING`.
-            page_size (Optional[int]):
-                Optional. The maximum number of entries in each page of results
-                from this request. Non-positive values are ignored. Defaults
-                to a sensible value set by the API.
-            page_token (Optional[str]):
-                Optional. If present, return the next batch of entries, using
-                the value, which must correspond to the ``nextPageToken`` value
-                returned in the previous response.  Deprecated: use the ``pages``
-                property of the returned iterator instead of manually passing
-                the token.
+            max_results (Optional[int]):
+                Optional. The maximum number of entries to return.
+                Non-positive values are ignored. Defaults
+                to unlimited.
 
         Returns:
             Iterator[~logging_v2.entries.LogEntry]
@@ -317,8 +312,7 @@ def list_entries(
             resource_names=resource_names,
             filter_=filter_,
             order_by=order_by,
-            page_size=page_size,
-            page_token=page_token,
+            max_results=max_results,
         )