1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
# -*- coding: utf-8 -*-
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from typing import (
Any,
Callable,
Sequence,
Tuple,
)
from google.longrunning import operations_pb2
class ListOperationsPagerBase:
"""A pager for iterating through ``list_operations`` requests.
This class thinly wraps an initial
:class:`google.longrunning.operations_pb2.ListOperationsResponse` object, and
provides an ``__iter__`` method to iterate through its
``operations`` field.
If there are more pages, the ``__iter__`` method will make additional
``ListOperations`` requests and continue to iterate
through the ``operations`` field on the
corresponding responses.
All the usual :class:`google.longrunning.operations_pb2.ListOperationsResponse`
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.
"""
def __init__(
self,
method: Callable[..., operations_pb2.ListOperationsResponse],
request: operations_pb2.ListOperationsRequest,
response: operations_pb2.ListOperationsResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.longrunning.operations_pb2.ListOperationsRequest):
The initial request object.
response (google.longrunning.operations_pb2.ListOperationsResponse):
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 = request
self._response = response
self._metadata = metadata
def __getattr__(self, name: str) -> Any:
return getattr(self._response, name)
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
|