def test_list_realms(transport: str = "grpc"): client = RealmsServiceClient( 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 = realms.ListRealmsRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_realms), "__call__") as call: # Designate an appropriate return value for the call. call.return_value = realms.ListRealmsResponse( next_page_token="next_page_token_value", unreachable=["unreachable_value"]) response = client.list_realms(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the response is the type that we expect. assert isinstance(response, pagers.ListRealmsPager) assert response.next_page_token == "next_page_token_value" assert response.unreachable == ["unreachable_value"]
def test_list_realms_flattened_error(): client = RealmsServiceClient( credentials=credentials.AnonymousCredentials()) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.list_realms(realms.ListRealmsRequest(), parent="parent_value")
def __init__(self, method: Callable[..., realms.ListRealmsResponse], request: realms.ListRealmsRequest, response: realms.ListRealmsResponse, *, 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.gaming_v1.types.ListRealmsRequest): The initial request object. response (google.cloud.gaming_v1.types.ListRealmsResponse): 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 = realms.ListRealmsRequest(request) self._response = response self._metadata = metadata
def test_list_realms_field_headers(): client = RealmsServiceClient( credentials=credentials.AnonymousCredentials()) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. request = realms.ListRealmsRequest(parent="parent/value") # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_realms), "__call__") as call: call.return_value = realms.ListRealmsResponse() client.list_realms(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the field header was sent. _, _, kw = call.mock_calls[0] assert ("x-goog-request-params", "parent=parent/value") in kw["metadata"]
def list_realms( self, request: realms.ListRealmsRequest = None, *, parent: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListRealmsPager: r"""Lists Realms in a given project and Location. Args: request (:class:`~.realms.ListRealmsRequest`): The request object. Request message for RealmsService.ListRealms. parent (:class:`str`): Required. The parent resource name. Uses the form: ``projects/{project}/locations/{location}``. 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.ListRealmsPager: Response message for RealmsService.ListRealms. 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. if request is not None and any([parent]): raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) request = realms.ListRealmsRequest(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.wrap_method( self._transport.list_realms, default_timeout=None, client_info=_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 = 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.ListRealmsPager( method=rpc, request=request, response=response ) # Done; return the response. return response
async def list_realms( self, request: Union[realms.ListRealmsRequest, dict] = None, *, parent: str = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListRealmsAsyncPager: r"""Lists realms in a given project and location. .. code-block:: python from google.cloud import gaming_v1 async def sample_list_realms(): # Create a client client = gaming_v1.RealmsServiceAsyncClient() # Initialize request argument(s) request = gaming_v1.ListRealmsRequest( parent="parent_value", ) # Make the request page_result = client.list_realms(request=request) # Handle the response async for response in page_result: print(response) Args: request (Union[google.cloud.gaming_v1.types.ListRealmsRequest, dict]): The request object. Request message for RealmsService.ListRealms. parent (:class:`str`): Required. The parent resource name, in the following form: ``projects/{project}/locations/{location}``. 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.gaming_v1.services.realms_service.pagers.ListRealmsAsyncPager: Response message for RealmsService.ListRealms. 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([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 = realms.ListRealmsRequest(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_realms, default_retry=retries.Retry( initial=1.0, maximum=10.0, multiplier=1.3, predicate=retries.if_exception_type( core_exceptions.ServiceUnavailable, ), deadline=60.0, ), default_timeout=60.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.ListRealmsAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
def list_realms( self, request: Union[realms.ListRealmsRequest, dict] = None, *, parent: str = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListRealmsPager: r"""Lists realms in a given project and location. .. code-block:: python from google.cloud import gaming_v1 def sample_list_realms(): # Create a client client = gaming_v1.RealmsServiceClient() # Initialize request argument(s) request = gaming_v1.ListRealmsRequest( parent="parent_value", ) # Make the request page_result = client.list_realms(request=request) # Handle the response for response in page_result: print(response) Args: request (Union[google.cloud.gaming_v1.types.ListRealmsRequest, dict]): The request object. Request message for RealmsService.ListRealms. parent (str): Required. The parent resource name, in the following form: ``projects/{project}/locations/{location}``. 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.gaming_v1.services.realms_service.pagers.ListRealmsPager: Response message for RealmsService.ListRealms. 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([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 realms.ListRealmsRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, realms.ListRealmsRequest): request = realms.ListRealmsRequest(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_realms] # 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.ListRealmsPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response