async def list_dashboards( self, request: Union[dashboards_service.ListDashboardsRequest, dict] = None, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDashboardsAsyncPager: r"""Lists the existing dashboards. This method requires the ``monitoring.dashboards.list`` permission on the specified project. For more information, see `Cloud Identity and Access Management <https://cloud.google.com/iam>`__. Args: request (Union[google.cloud.monitoring_dashboard_v1.types.ListDashboardsRequest, dict]): The request object. The `ListDashboards` request. 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_dashboard_v1.services.dashboards_service.pagers.ListDashboardsAsyncPager: The ListDashboards request. Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. request = dashboards_service.ListDashboardsRequest(request) # 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_dashboards, default_timeout=None, 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.ListDashboardsAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
def __init__(self, method: Callable[..., dashboards_service.ListDashboardsResponse], request: dashboards_service.ListDashboardsRequest, response: dashboards_service.ListDashboardsResponse, *, 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_dashboard_v1.types.ListDashboardsRequest): The initial request object. response (google.cloud.monitoring_dashboard_v1.types.ListDashboardsResponse): 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 = dashboards_service.ListDashboardsRequest(request) self._response = response self._metadata = metadata
def list_dashboards( self, request: dashboards_service.ListDashboardsRequest = None, *, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDashboardsPager: r"""Lists the existing dashboards. This method requires the ``monitoring.dashboards.list`` permission on the specified project. For more information, see `Cloud Identity and Access Management <https://cloud.google.com/iam>`__. Args: request (google.cloud.monitoring_dashboard_v1.types.ListDashboardsRequest): The request object. The `ListDashboards` request. 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_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager: The ListDashboards request. Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. # Minor optimization to avoid making a copy if the user passes # in a dashboards_service.ListDashboardsRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, dashboards_service.ListDashboardsRequest): request = dashboards_service.ListDashboardsRequest(request) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.list_dashboards] # 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.ListDashboardsPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response