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,
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 |
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 |
The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment. |
parent |
Required. The parent resource name. Uses the form: |
game_server_deployment |
Required. The game server delpoyment resource to be created. This corresponds to the |
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 |
| An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment |
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 |
The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment. |
name |
Required. The name of the game server delpoyment to delete. Uses the form: |
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 |
| An object representing a long-running operation. The result type for the operation will be .empty.Empty 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 |
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 |
| 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 |
The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment. |
name |
Required. The name of the game server delpoyment to retrieve. Uses the form: |
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 |
| 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 |
The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout. |
name |
Required. The name of the game server delpoyment to retrieve. Uses the form: |
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 |
| 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 |
The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments. |
parent |
Required. The parent resource name. Uses the form: |
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 |
| 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 |
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 |
| 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 |
The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels. |
game_server_deployment |
Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated. This corresponds to the |
update_mask |
Required. Mask of fields to update. At least one path must be supplied in this field. For the |
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 |
| An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment |
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 |
The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment. |
rollout |
Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated. This corresponds to the |
update_mask |
Required. Mask of fields to update. At least one path must be supplied in this field. For the |
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 |
| An object representing a long-running operation. The result type for the operation will be .game_server_deployments.GameServerDeployment |