def __init__( self, method: Callable[..., uptime_service.ListUptimeCheckConfigsResponse], request: uptime_service.ListUptimeCheckConfigsRequest, response: uptime_service.ListUptimeCheckConfigsResponse, *, 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.monitoring_v3.types.ListUptimeCheckConfigsRequest): The initial request object. response (google.cloud.monitoring_v3.types.ListUptimeCheckConfigsResponse): 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 = uptime_service.ListUptimeCheckConfigsRequest(request) self._response = response self._metadata = metadata
def list_uptime_check_configs( self, request: uptime_service.ListUptimeCheckConfigsRequest = None, *, parent: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListUptimeCheckConfigsPager: r"""Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). Args: request (:class:`~.uptime_service.ListUptimeCheckConfigsRequest`): The request object. The protocol for the `ListUptimeCheckConfigs` request. parent (:class:`str`): Required. The project whose Uptime check configurations are listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This corresponds to the ``parent`` 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: ~.pagers.ListUptimeCheckConfigsPager: The protocol for the ``ListUptimeCheckConfigs`` response. 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([parent]) 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 uptime_service.ListUptimeCheckConfigsRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, uptime_service.ListUptimeCheckConfigsRequest): request = uptime_service.ListUptimeCheckConfigsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.list_uptime_check_configs] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("parent", request.parent), )), ) # 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.ListUptimeCheckConfigsPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
async def list_uptime_check_configs( self, request: uptime_service.ListUptimeCheckConfigsRequest = None, *, parent: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListUptimeCheckConfigsAsyncPager: r"""Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). Args: request (:class:`google.cloud.monitoring_v3.types.ListUptimeCheckConfigsRequest`): The request object. The protocol for the `ListUptimeCheckConfigs` request. parent (:class:`str`): Required. The `project <https://cloud.google.com/monitoring/api/v3#project_name>`__ whose Uptime check configurations are listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This corresponds to the ``parent`` 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.monitoring_v3.services.uptime_check_service.pagers.ListUptimeCheckConfigsAsyncPager: The protocol for the ListUptimeCheckConfigs response. 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([parent]) 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 = uptime_service.ListUptimeCheckConfigsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent # 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_uptime_check_configs, default_retry=retries.Retry( initial=0.1, maximum=30.0, multiplier=1.3, predicate=retries.if_exception_type( core_exceptions.ServiceUnavailable, ), deadline=30.0, ), default_timeout=30.0, client_info=DEFAULT_CLIENT_INFO, ) # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("parent", request.parent), )), ) # 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.ListUptimeCheckConfigsAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response