Class GameServerDeploymentsServiceAsyncClient (0.3.0)

GameServerDeploymentsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

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

Methods

GameServerDeploymentsServiceAsyncClient

GameServerDeploymentsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the game server deployments service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .GameServerDeploymentsServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

create_game_server_deployment

create_game_server_deployment(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.CreateGameServerDeploymentRequest] = None, *, parent: Optional[str] = None, game_server_deployment: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeployment] = None, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`.game_server_deployments.CreateGameServerDeploymentRequest` The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment.
`parent`	`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.
`game_server_deployment`	`.game_server_deployments.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
Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment : A game server deployment resource.

delete_game_server_deployment

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

Deletes a single game server deployment.

Parameters
Name	Description
`request`	`.game_server_deployments.DeleteGameServerDeploymentRequest` The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment.
`name`	`str` Required. The name of the game server delpoyment to delete. 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

Type Description

.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be

.empty.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[google.cloud.gaming_v1.types.game_server_deployments.FetchDeploymentStateRequest] = None, *, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`.game_server_deployments.FetchDeploymentStateRequest` 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
Type	Description
`.game_server_deployments.FetchDeploymentStateResponse`	Response 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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The 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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

game_server_deployment_path

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

Return a fully-qualified game_server_deployment string.

game_server_deployment_rollout_path

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

Return a fully-qualified game_server_deployment_rollout string.

get_game_server_deployment

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

Gets details of a single game server deployment.

Parameters
Name	Description
`request`	`.game_server_deployments.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
Type	Description
`.game_server_deployments.GameServerDeployment`	A game server deployment resource.

get_game_server_deployment_rollout

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

Gets details a single game server deployment rollout.

Parameters
Name	Description
`request`	`.game_server_deployments.GetGameServerDeploymentRolloutRequest` The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.
`name`	`str` Required. The name of the game server delpoyment to retrieve. Uses the 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
Type	Description
`.game_server_deployments.GameServerDeploymentRollout`	The game server deployment rollout which represents the desired rollout state.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_game_server_deployments

list_game_server_deployments(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.ListGameServerDeploymentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`.game_server_deployments.ListGameServerDeploymentsRequest` The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments.
`parent`	`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
Type	Description
`.pagers.ListGameServerDeploymentsAsyncPager`	Response message for GameServerDeploymentsService.ListGameServerDeployments. Iterating over this object will yield results and resolve additional pages automatically.

preview_game_server_deployment_rollout

preview_game_server_deployment_rollout(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.PreviewGameServerDeploymentRolloutRequest] = None, *, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`.game_server_deployments.PreviewGameServerDeploymentRolloutRequest` 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
Type	Description
`.game_server_deployments.PreviewGameServerDeploymentRolloutResponse`	Response 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[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches a game server deployment.

Parameters
Name	Description
`request`	`.game_server_deployments.UpdateGameServerDeploymentRequest` The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.
`game_server_deployment`	`.game_server_deployments.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`	`.field_mask.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
Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment : A game server deployment resource.

update_game_server_deployment_rollout

update_game_server_deployment_rollout(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRolloutRequest] = None, *, rollout: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeploymentRollout] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`.game_server_deployments.UpdateGameServerDeploymentRolloutRequest` The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.
`rollout`	`.game_server_deployments.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`	`.field_mask.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
Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment : A game server deployment resource.