def test_get_game_server_deployment(transport: str = "grpc"):
client = GameServerDeploymentsServiceClient(
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_deployments.GetGameServerDeploymentRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_game_server_deployment),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = game_server_deployments.GameServerDeployment(
name="name_value",
etag="etag_value",
description="description_value")
response = client.get_game_server_deployment(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, game_server_deployments.GameServerDeployment)
assert response.name == "name_value"
assert response.etag == "etag_value"
assert response.description == "description_value"
def test_get_game_server_deployment_flattened_error():
client = GameServerDeploymentsServiceClient(
credentials=credentials.AnonymousCredentials())
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.get_game_server_deployment(
game_server_deployments.GetGameServerDeploymentRequest(),
name="name_value")
def get_deployment(project_id, deployment_id):
"""Gets a game server deployment."""
client = gaming.GameServerDeploymentsServiceClient()
# Location is hard coded as global, as game server deployments can
# only be created in global. This is done for all operations on
# game server deployments, as well as for its child resource types.
request = game_server_deployments.GetGameServerDeploymentRequest(
name=
f"projects/{project_id}/locations/global/gameServerDeployments/{deployment_id}",
)
response = client.get_game_server_deployment(request)
print(f"Get deployment response:\n{response}")
return response
def test_get_game_server_deployment_field_headers():
client = GameServerDeploymentsServiceClient(
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_deployments.GetGameServerDeploymentRequest(
name="name/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_game_server_deployment),
"__call__") as call:
call.return_value = game_server_deployments.GameServerDeployment()
client.get_game_server_deployment(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", "name=name/value") in kw["metadata"]
def get_game_server_deployment(
self,
request: game_server_deployments.GetGameServerDeploymentRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> game_server_deployments.GameServerDeployment:
r"""Gets details of a single game server deployment.
Args:
request (google.cloud.gaming_v1.types.GetGameServerDeploymentRequest):
The request object. Request message for
GameServerDeploymentsService.GetGameServerDeployment.
name (str):
Required. The name of the game server delpoyment to
retrieve. Uses the form:
``projects/{project}/locations/{location}/gameServerDeployments/{deployment}``.
This corresponds to the ``name`` 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.types.GameServerDeployment:
A game server deployment resource.
"""
# 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([name])
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_deployments.GetGameServerDeploymentRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(
request,
game_server_deployments.GetGameServerDeploymentRequest):
request = game_server_deployments.GetGameServerDeploymentRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.get_game_server_deployment]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def get_game_server_deployment(
self,
request: Union[game_server_deployments.GetGameServerDeploymentRequest,
dict] = None,
*,
name: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> game_server_deployments.GameServerDeployment:
r"""Gets details of a single game server deployment.
.. code-block:: python
from google.cloud import gaming_v1
async def sample_get_game_server_deployment():
# Create a client
client = gaming_v1.GameServerDeploymentsServiceAsyncClient()
# Initialize request argument(s)
request = gaming_v1.GetGameServerDeploymentRequest(
name="name_value",
)
# Make the request
response = await client.get_game_server_deployment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.gaming_v1.types.GetGameServerDeploymentRequest, dict]):
The request object. Request message for
GameServerDeploymentsService.GetGameServerDeployment.
name (:class:`str`):
Required. The name of the game server delpoyment to
retrieve, in the following form:
``projects/{project}/locations/{location}/gameServerDeployments/{deployment}``.
This corresponds to the ``name`` 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.types.GameServerDeployment:
A game server deployment resource.
"""
# 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([name])
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 = game_server_deployments.GetGameServerDeploymentRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_game_server_deployment,
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(
(("name", request.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def get_game_server_deployment(
self,
request: game_server_deployments.GetGameServerDeploymentRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> game_server_deployments.GameServerDeployment:
r"""Gets details of a single Game Server Deployment.
Args:
request (:class:`~.game_server_deployments.GetGameServerDeploymentRequest`):
The request object. Request message for
GameServerDeploymentsService.GetGameServerDeployment.
name (:class:`str`):
Required. The name of the Game Server Deployment to
retrieve. Uses the form:
``projects/{project}/locations/{location}/gameServerDeployments/{deployment}``.
This corresponds to the ``name`` 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:
~.game_server_deployments.GameServerDeployment:
A Game Server Deployment resource.
"""
# 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([name]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = game_server_deployments.GetGameServerDeploymentRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.get_game_server_deployment,
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(
(("name", request.name), )), )
# Send the request.
response = rpc(request,
retry=retry,
timeout=timeout,
metadata=metadata)
# Done; return the response.
return response