def __init__(self,
method: Callable[..., logging.ListLogEntriesResponse],
request: logging.ListLogEntriesRequest,
response: logging.ListLogEntriesResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.logging_v2.types.ListLogEntriesRequest):
The initial request object.
response (google.cloud.logging_v2.types.ListLogEntriesResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = logging.ListLogEntriesRequest(request)
self._response = response
self._metadata = metadata
def list_log_entries(
self,
request: logging.ListLogEntriesRequest = None,
*,
resource_names: Sequence[str] = None,
filter: str = None,
order_by: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListLogEntriesPager:
r"""Lists log entries. Use this method to retrieve log entries that
originated from a project/folder/organization/billing account.
For ways to export log entries, see `Exporting
Logs <https://cloud.google.com/logging/docs/export>`__.
Args:
request (google.cloud.logging_v2.types.ListLogEntriesRequest):
The request object. The parameters to `ListLogEntries`.
resource_names (Sequence[str]):
Required. Names of one or more parent resources from
which to retrieve log entries:
::
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
May alternatively be one or more views
projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
Projects listed in the ``project_ids`` field are added
to this list.
This corresponds to the ``resource_names`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (str):
Optional. A filter that chooses which log entries to
return. See `Advanced Logs
Queries <https://cloud.google.com/logging/docs/view/advanced-queries>`__.
Only log entries that match the filter are returned. An
empty filter matches all log entries in the resources
listed in ``resource_names``. Referencing a parent
resource that is not listed in ``resource_names`` will
cause the filter to return no results. The maximum
length of the filter is 20000 characters.
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
order_by (str):
Optional. How the results should be sorted. Presently,
the only permitted values are ``"timestamp asc"``
(default) and ``"timestamp desc"``. The first option
returns entries in order of increasing values of
``LogEntry.timestamp`` (oldest first), and the second
option returns entries in order of decreasing timestamps
(newest first). Entries with equal timestamps are
returned in order of their ``insert_id`` values.
This corresponds to the ``order_by`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.logging_v2.services.logging_service_v2.pagers.ListLogEntriesPager:
Result returned from ListLogEntries.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([resource_names, filter, order_by])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a logging.ListLogEntriesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, logging.ListLogEntriesRequest):
request = logging.ListLogEntriesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if resource_names is not None:
request.resource_names = resource_names
if filter is not None:
request.filter = filter
if order_by is not None:
request.order_by = order_by
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.list_log_entries]
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListLogEntriesPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
async def list_log_entries(
self,
request: Union[logging.ListLogEntriesRequest, dict] = None,
*,
resource_names: Sequence[str] = None,
filter: str = None,
order_by: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListLogEntriesAsyncPager:
r"""Lists log entries. Use this method to retrieve log entries that
originated from a project/folder/organization/billing account.
For ways to export log entries, see `Exporting
Logs <https://cloud.google.com/logging/docs/export>`__.
.. code-block:: python
from google.cloud import logging_v2
def sample_list_log_entries():
# Create a client
client = logging_v2.LoggingServiceV2Client()
# Initialize request argument(s)
request = logging_v2.ListLogEntriesRequest(
resource_names=['resource_names_value_1', 'resource_names_value_2'],
)
# Make the request
page_result = client.list_log_entries(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.logging_v2.types.ListLogEntriesRequest, dict]):
The request object. The parameters to `ListLogEntries`.
resource_names (:class:`Sequence[str]`):
Required. Names of one or more parent resources from
which to retrieve log entries:
::
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
May alternatively be one or more views
projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
Projects listed in the ``project_ids`` field are added
to this list.
This corresponds to the ``resource_names`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (:class:`str`):
Optional. A filter that chooses which log entries to
return. See `Advanced Logs
Queries <https://cloud.google.com/logging/docs/view/advanced-queries>`__.
Only log entries that match the filter are returned. An
empty filter matches all log entries in the resources
listed in ``resource_names``. Referencing a parent
resource that is not listed in ``resource_names`` will
cause the filter to return no results. The maximum
length of the filter is 20000 characters.
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
order_by (:class:`str`):
Optional. How the results should be sorted. Presently,
the only permitted values are ``"timestamp asc"``
(default) and ``"timestamp desc"``. The first option
returns entries in order of increasing values of
``LogEntry.timestamp`` (oldest first), and the second
option returns entries in order of decreasing timestamps
(newest first). Entries with equal timestamps are
returned in order of their ``insert_id`` values.
This corresponds to the ``order_by`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.logging_v2.services.logging_service_v2.pagers.ListLogEntriesAsyncPager:
Result returned from ListLogEntries.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([resource_names, filter, order_by])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = logging.ListLogEntriesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if filter is not None:
request.filter = filter
if order_by is not None:
request.order_by = order_by
if resource_names:
request.resource_names.extend(resource_names)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.list_log_entries,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.InternalServerError,
core_exceptions.ServiceUnavailable,
),
deadline=60.0,
),
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.ListLogEntriesAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
