def __init__(
self,
method: Callable[...,
game_server_configs.ListGameServerConfigsResponse],
request: game_server_configs.ListGameServerConfigsRequest,
response: game_server_configs.ListGameServerConfigsResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`~.game_server_configs.ListGameServerConfigsRequest`):
The initial request object.
response (:class:`~.game_server_configs.ListGameServerConfigsResponse`):
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 = game_server_configs.ListGameServerConfigsRequest(
request)
self._response = response
self._metadata = metadata
def test_list_game_server_configs(transport: str = "grpc"):
client = GameServerConfigsServiceClient(
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 = game_server_configs.ListGameServerConfigsRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_game_server_configs),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = game_server_configs.ListGameServerConfigsResponse(
next_page_token="next_page_token_value",
unreachable=["unreachable_value"])
response = client.list_game_server_configs(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.ListGameServerConfigsPager)
assert response.next_page_token == "next_page_token_value"
assert response.unreachable == ["unreachable_value"]
def test_list_game_server_configs_flattened_error():
client = GameServerConfigsServiceClient(
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_game_server_configs(
game_server_configs.ListGameServerConfigsRequest(),
parent="parent_value")
def __init__(
self,
method: Callable[[game_server_configs.ListGameServerConfigsRequest],
game_server_configs.ListGameServerConfigsResponse, ],
request: game_server_configs.ListGameServerConfigsRequest,
response: game_server_configs.ListGameServerConfigsResponse,
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`~.game_server_configs.ListGameServerConfigsRequest`):
The initial request object.
response (:class:`~.game_server_configs.ListGameServerConfigsResponse`):
The initial response object.
"""
self._method = method
self._request = game_server_configs.ListGameServerConfigsRequest(
request)
self._response = response
def test_list_game_server_configs_field_headers():
client = GameServerConfigsServiceClient(
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 = game_server_configs.ListGameServerConfigsRequest(
parent="parent/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_game_server_configs),
"__call__") as call:
call.return_value = game_server_configs.ListGameServerConfigsResponse()
client.list_game_server_configs(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"]
async def list_game_server_configs(
self,
request: game_server_configs.ListGameServerConfigsRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListGameServerConfigsAsyncPager:
r"""Lists game server configs in a given project,
location, and game server deployment.
Args:
request (:class:`~.game_server_configs.ListGameServerConfigsRequest`):
The request object. Request message for
GameServerConfigsService.ListGameServerConfigs.
parent (:class:`str`):
Required. The parent resource name. Uses the form:
``projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*``.
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.ListGameServerConfigsAsyncPager:
Response message for
GameServerConfigsService.ListGameServerConfigs.
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 = game_server_configs.ListGameServerConfigsRequest(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_game_server_configs,
default_retry=retries.Retry(
initial=1.0,
maximum=10.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.ServiceUnavailable, ),
),
default_timeout=60.0,
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 = 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.ListGameServerConfigsAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
def list_game_server_configs(
self,
request: game_server_configs.ListGameServerConfigsRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListGameServerConfigsPager:
r"""Lists game server configs in a given project,
location, and game server deployment.
Args:
request (google.cloud.gaming_v1.types.ListGameServerConfigsRequest):
The request object. Request message for
GameServerConfigsService.ListGameServerConfigs.
parent (str):
Required. The parent resource name. Uses the form:
``projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*``.
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.game_server_configs_service.pagers.ListGameServerConfigsPager:
Response message for
GameServerConfigsService.ListGameServerConfigs.
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 game_server_configs.ListGameServerConfigsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, game_server_configs.ListGameServerConfigsRequest):
request = game_server_configs.ListGameServerConfigsRequest(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_game_server_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.ListGameServerConfigsPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
