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.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The game server deployment is used to control the deployment of Agones fleets.
Inheritance
builtins.object > GameServerDeploymentsServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
GameServerDeploymentsServiceTransport | The transport used by the client instance. |
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.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the game server deployments service client.
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 |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
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.
Name | Description |
request |
CreateGameServerDeploymentRequest
The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment. |
parent |
`str`
Required. The parent resource name. Uses the form: |
game_server_deployment |
GameServerDeployment
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An 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[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.
Name | Description |
request |
DeleteGameServerDeploymentRequest
The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment. |
name |
`str`
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An 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[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.
Name | Description |
request |
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. |
Type | Description |
google.cloud.gaming_v1.types.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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
GameServerDeploymentsServiceAsyncClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
GameServerDeploymentsServiceAsyncClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
GameServerDeploymentsServiceAsyncClient | The constructed client. |
game_server_deployment_path
game_server_deployment_path(project: str, location: str, deployment: str)
Returns a fully-qualified game_server_deployment string.
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.
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.
Name | Description |
request |
GetGameServerDeploymentRequest
The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment. |
name |
`str`
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. |
Type | Description |
google.cloud.gaming_v1.types.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.
Name | Description |
request |
GetGameServerDeploymentRolloutRequest
The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout. |
name |
`str`
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. |
Type | Description |
google.cloud.gaming_v1.types.GameServerDeploymentRollout | The game server deployment rollout which represents the desired rollout state. |
get_transport_class
get_transport_class()
Returns 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.
Name | Description |
request |
ListGameServerDeploymentsRequest
The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments. |
parent |
`str`
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. |
Type | Description |
google.cloud.gaming_v1.services.game_server_deployments_service.pagers.ListGameServerDeploymentsAsyncPager | Response 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.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_game_server_deployment_path
parse_game_server_deployment_path(path: str)
Parses a game_server_deployment path into its component segments.
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.
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.
Name | Description |
request |
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. |
Type | Description |
google.cloud.gaming_v1.types.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.
Name | Description |
request |
UpdateGameServerDeploymentRequest
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 |
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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An 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[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.
Name | Description |
request |
UpdateGameServerDeploymentRolloutRequest
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 |
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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be GameServerDeployment A game server deployment resource. |