async def test_list_traces_async(transport: str = "grpc_asyncio"): client = TraceServiceAsyncClient( credentials=credentials.AnonymousCredentials(), transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, # and we are mocking out the actual API, so just send an empty request. request = trace.ListTracesRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._client._transport.list_traces), "__call__") as call: # Designate an appropriate return value for the call. call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( trace.ListTracesResponse( next_page_token="next_page_token_value", )) response = await client.list_traces(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the response is the type that we expect. assert isinstance(response, pagers.ListTracesAsyncPager) assert response.next_page_token == "next_page_token_value"
async def test_list_traces_flattened_error_async(): client = TraceServiceAsyncClient( credentials=credentials.AnonymousCredentials(), ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): await client.list_traces( trace.ListTracesRequest(), project_id="project_id_value", )
def __init__( self, method: Callable[..., trace.ListTracesResponse], request: trace.ListTracesRequest, response: trace.ListTracesResponse, *, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (:class:`~.trace.ListTracesRequest`): The initial request object. response (:class:`~.trace.ListTracesResponse`): 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 = trace.ListTracesRequest(request) self._response = response self._metadata = metadata
def list_traces( self, request: trace.ListTracesRequest = None, *, project_id: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTracesPager: r"""Returns of a list of traces that match the specified filter conditions. Args: request (:class:`~.trace.ListTracesRequest`): The request object. The request message for the `ListTraces` method. All fields are required unless specified. project_id (:class:`str`): Required. ID of the Cloud project where the trace data is stored. This corresponds to the ``project_id`` 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.ListTracesPager: The response message for the ``ListTraces`` method. 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([project_id]) 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 trace.ListTracesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, trace.ListTracesRequest): request = trace.ListTracesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project_id is not None: request.project_id = project_id # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.list_traces] # 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.ListTracesPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
async def list_traces( self, request: trace.ListTracesRequest = None, *, project_id: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTracesAsyncPager: r"""Returns of a list of traces that match the specified filter conditions. Args: request (:class:`google.cloud.trace_v1.types.ListTracesRequest`): The request object. The request message for the `ListTraces` method. All fields are required unless specified. project_id (:class:`str`): Required. ID of the Cloud project where the trace data is stored. This corresponds to the ``project_id`` 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.trace_v1.services.trace_service.pagers.ListTracesAsyncPager: The response message for the ListTraces method. 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([project_id]) 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 = trace.ListTracesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project_id is not None: request.project_id = project_id # 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_traces, default_retry=retries.Retry( initial=0.1, maximum=1.0, multiplier=1.2, predicate=retries.if_exception_type( core_exceptions.DeadlineExceeded, core_exceptions.ServiceUnavailable, ), deadline=45.0, ), default_timeout=45.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.ListTracesAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response