def update_rollout_override(project_id, deployment_id, config_id,
realm_location, realm_id):
"""Update the rollout of a game server deployment to set the override config."""
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.UpdateGameServerDeploymentRolloutRequest(
)
request.rollout.name = (
f"projects/{project_id}/locations/global/gameServerDeployments/{deployment_id}"
)
realm_name = f"projects/{project_id}/locations/{realm_location}/realms/{realm_id}"
config_override = game_server_deployments.GameServerConfigOverride(
realms_selector=common.RealmSelector(realms=[realm_name]),
config_version=config_id,
)
request.rollout.game_server_config_overrides = [config_override]
request.update_mask = field_mask.FieldMask(
paths=["game_server_config_overrides"])
operation = client.update_game_server_deployment_rollout(request)
print(f"Update deployment rollout operation: {operation.operation.name}")
operation.result(timeout=120)
def test_update_game_server_deployment_rollout(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.UpdateGameServerDeploymentRolloutRequest(
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.update_game_server_deployment_rollout),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = operations_pb2.Operation(name="operations/spam")
response = client.update_game_server_deployment_rollout(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, future.Future)
def test_update_game_server_deployment_rollout_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.update_game_server_deployment_rollout(
game_server_deployments.UpdateGameServerDeploymentRolloutRequest(),
rollout=game_server_deployments.GameServerDeploymentRollout(
name="name_value"),
update_mask=field_mask.FieldMask(paths=["paths_value"]),
)
def update_rollout_default(project_id, deployment_id, config_id):
"""Update the rollout of a game server deployment to set the default config."""
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.UpdateGameServerDeploymentRolloutRequest()
request.rollout.name = f"projects/{project_id}/locations/global/gameServerDeployments/{deployment_id}"
request.rollout.default_game_server_config = config_id
request.update_mask = field_mask.FieldMask(paths=["default_game_server_config"])
operation = client.update_game_server_deployment_rollout(request)
print(f"Update deployment rollout operation: {operation.operation.name}")
operation.result(timeout=120)
def update_game_server_deployment_rollout(
self,
request: game_server_deployments.
UpdateGameServerDeploymentRolloutRequest = None,
*,
rollout: game_server_deployments.
GameServerDeploymentRollout = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Patches a single game server deployment rollout. The method will
not return an error if the update does not affect any existing
realms. For example - if the default_game_server_config is
changed but all existing realms use the override, that is valid.
Similarly, if a non existing realm is explicitly called out in
game_server_config_overrides field, that will also not result in
an error.
Args:
request (google.cloud.gaming_v1.types.UpdateGameServerDeploymentRolloutRequest):
The request object. Request message for
GameServerDeploymentsService.UpdateGameServerRolloutDeployment.
rollout (google.cloud.gaming_v1.types.GameServerDeploymentRollout):
Required. The game server delpoyment rollout to be
updated. Only fields specified in update_mask are
updated.
This corresponds to the ``rollout`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Required. Mask of fields to update. At least one path
must be supplied in this field. For the ``FieldMask``
definition, see
https: //developers.google.com/protocol-buffers //
/docs/reference/google.protobuf#fieldmask
This corresponds to the ``update_mask`` 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.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be
:class:`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([rollout, update_mask])
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.UpdateGameServerDeploymentRolloutRequest.
# 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.
UpdateGameServerDeploymentRolloutRequest):
request = game_server_deployments.UpdateGameServerDeploymentRolloutRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if rollout is not None:
request.rollout = rollout
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.update_game_server_deployment_rollout]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("rollout.name", request.rollout.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
game_server_deployments.GameServerDeployment,
metadata_type=common.OperationMetadata,
)
# Done; return the response.
return response
async def update_game_server_deployment_rollout(
self,
request: Union[
game_server_deployments.UpdateGameServerDeploymentRolloutRequest,
dict] = None,
*,
rollout: game_server_deployments.GameServerDeploymentRollout = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Patches a single game server deployment rollout. The method will
not return an error if the update does not affect any existing
realms. For example - if the default_game_server_config is
changed but all existing realms use the override, that is valid.
Similarly, if a non existing realm is explicitly called out in
game_server_config_overrides field, that will also not result in
an error.
.. code-block:: python
from google.cloud import gaming_v1
async def sample_update_game_server_deployment_rollout():
# Create a client
client = gaming_v1.GameServerDeploymentsServiceAsyncClient()
# Initialize request argument(s)
request = gaming_v1.UpdateGameServerDeploymentRolloutRequest(
)
# Make the request
operation = client.update_game_server_deployment_rollout(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.gaming_v1.types.UpdateGameServerDeploymentRolloutRequest, dict]):
The request object. Request message for
GameServerDeploymentsService.UpdateGameServerRolloutDeployment.
rollout (:class:`google.cloud.gaming_v1.types.GameServerDeploymentRollout`):
Required. The game server delpoyment rollout to be
updated. Only fields specified in update_mask are
updated.
This corresponds to the ``rollout`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Required. Mask of fields to update. At least one path
must be supplied in this field. For the ``FieldMask``
definition, see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
This corresponds to the ``update_mask`` 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.api_core.operation_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be
:class:`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([rollout, update_mask])
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.UpdateGameServerDeploymentRolloutRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if rollout is not None:
request.rollout = rollout
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.update_game_server_deployment_rollout,
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(
(("rollout.name", request.rollout.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation_async.from_gapic(
response,
self._client._transport.operations_client,
game_server_deployments.GameServerDeployment,
metadata_type=common.OperationMetadata,
)
# Done; return the response.
return response