Class GameServerDeploymentsServiceAsyncClient

The game server deployment is used to control the deployment of Agones fleets.

Inheritance

builtins.object > GameServerDeploymentsServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
GameServerDeploymentsServiceTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_game_server_deployment

create_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.CreateGameServerDeploymentRequest, dict]] = None, *, parent: Optional[str] = None, game_server_deployment: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeployment] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new game server deployment in a given project and location.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.CreateGameServerDeploymentRequest, dict]

The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment.

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.

game_server_deployment GameServerDeployment

Required. The game server delpoyment resource to be created. This corresponds to the game_server_deployment 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be GameServerDeployment A game server deployment resource.

delete_game_server_deployment

delete_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.DeleteGameServerDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single game server deployment.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.DeleteGameServerDeploymentRequest, dict]

The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

name `str`

Required. The name of the game server delpoyment to delete, 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

fetch_deployment_state

fetch_deployment_state(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.FetchDeploymentStateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.FetchDeploymentStateRequest, dict]

The request object. Request message for GameServerDeploymentsService.FetchDeploymentState.

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
TypeDescription
google.cloud.gaming_v1.types.FetchDeploymentStateResponseResponse message for GameServerDeploymentsService.FetchDeploymentState.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
GameServerDeploymentsServiceAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
GameServerDeploymentsServiceAsyncClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
GameServerDeploymentsServiceAsyncClientThe constructed client.

game_server_deployment_path

game_server_deployment_path(project: str, location: str, deployment: str)

Returns a fully-qualified game_server_deployment string.

Parameters
NameDescription
project str
location str
deployment str

game_server_deployment_rollout_path

game_server_deployment_rollout_path(project: str, location: str, deployment: str)

Returns a fully-qualified game_server_deployment_rollout string.

Parameters
NameDescription
project str
location str
deployment str

get_game_server_deployment

get_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.GetGameServerDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single game server deployment.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.GetGameServerDeploymentRequest, dict]

The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment.

name `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
TypeDescription
google.cloud.gaming_v1.types.GameServerDeploymentA game server deployment resource.

get_game_server_deployment_rollout

get_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.GetGameServerDeploymentRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details a single game server deployment rollout.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.GetGameServerDeploymentRolloutRequest, dict]

The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

name `str`

Required. The name of the game server delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout. 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
TypeDescription
google.cloud.gaming_v1.types.GameServerDeploymentRolloutThe game server deployment rollout which represents the desired rollout state.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

list_game_server_deployments

list_game_server_deployments(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.ListGameServerDeploymentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists game server deployments in a given project and location.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.ListGameServerDeploymentsRequest, dict]

The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments.

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
TypeDescription
google.cloud.gaming_v1.services.game_server_deployments_service.pagers.ListGameServerDeploymentsAsyncPagerResponse message for GameServerDeploymentsService.ListGameServerDeployments. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_game_server_deployment_path

parse_game_server_deployment_path(path: str)

Parses a game_server_deployment path into its component segments.

Parameter
NameDescription
path str

parse_game_server_deployment_rollout_path

parse_game_server_deployment_rollout_path(path: str)

Parses a game_server_deployment_rollout path into its component segments.

Parameter
NameDescription
path str

preview_game_server_deployment_rollout

preview_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.PreviewGameServerDeploymentRolloutRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.PreviewGameServerDeploymentRolloutRequest, dict]

The request object. Request message for PreviewGameServerDeploymentRollout.

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
TypeDescription
google.cloud.gaming_v1.types.PreviewGameServerDeploymentRolloutResponseResponse message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.

update_game_server_deployment

update_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRequest, dict]] = None, *, game_server_deployment: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches a game server deployment.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.UpdateGameServerDeploymentRequest, dict]

The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.

game_server_deployment GameServerDeployment

Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated. This corresponds to the game_server_deployment 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be GameServerDeployment A game server deployment resource.

update_game_server_deployment_rollout

update_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRolloutRequest, dict]] = None, *, rollout: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeploymentRollout] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
NameDescription
request Union[google.cloud.gaming_v1.types.UpdateGameServerDeploymentRolloutRequest, dict]

The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

rollout 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be GameServerDeployment A game server deployment resource.