API documentation for gaming_v1beta.types package.
Classes
CreateGameServerClusterRequest
Request message for GameServerClustersService.CreateGameServerCluster.
CreateGameServerConfigRequest
Request message for GameServerConfigsService.CreateGameServerConfig.
CreateGameServerDeploymentRequest
Request message for GameServerDeploymentsService.CreateGameServerDeployment.
CreateRealmRequest
Request message for RealmsService.CreateRealm. .. attribute:: parent
Required. The parent resource name. Uses the form:
projects/{project}/locations/{location}.
:type: str
DeleteGameServerClusterRequest
Request message for GameServerClustersService.DeleteGameServerCluster.
DeleteGameServerConfigRequest
Request message for GameServerConfigsService.DeleteGameServerConfig.
DeleteGameServerDeploymentRequest
Request message for GameServerDeploymentsService.DeleteGameServerDeployment.
DeleteRealmRequest
Request message for RealmsService.DeleteRealm. .. attribute:: name
Required. The name of the realm to delete. Uses the form:
projects/{project}/locations/{location}/realms/{realm}.
:type: str
DeployedFleetDetails
Details of the deployed Agones fleet. .. attribute:: deployed_fleet
Information about the Agones fleet.
:type: google.cloud.gaming_v1beta.types.DeployedFleetDetails.DeployedFleet
FetchDeploymentStateRequest
Request message for GameServerDeploymentsService.FetchDeploymentState.
FetchDeploymentStateResponse
Response message for GameServerDeploymentsService.FetchDeploymentState.
FleetConfig
Fleet configs for Agones. .. attribute:: fleet_spec
Agones fleet spec. Example spec:
https://agones.dev/site/docs/reference/fleet/.
:type: str
GameServerCluster
A game server cluster resource. .. attribute:: name
Required. The resource name of the game server cluster. Uses the form:
projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.
For example,
projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster.
:type: str
GameServerClusterConnectionInfo
The game server cluster connection information. .. attribute:: gke_cluster_reference
Reference to the GKE cluster where the game servers are installed.
GameServerConfig
A game server config resource. .. attribute:: name
The resource name of the game server config. Uses the form:
projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.
For example,
projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.
:type: str
GameServerConfigOverride
A game server config override. .. attribute:: realms_selector
Selector for choosing applicable realms.
GameServerDeployment
A game server deployment resource. .. attribute:: name
The resource name of the game server deployment. Uses the form:
projects/{project}/locations/{location}/gameServerDeployments/{deployment}.
For example,
projects/my-project/locations/{location}/gameServerDeployments/my-deployment.
:type: str
GameServerDeploymentRollout
The game server deployment rollout which represents the desired rollout state.
GetGameServerClusterRequest
Request message for GameServerClustersService.GetGameServerCluster.
GetGameServerConfigRequest
Request message for GameServerConfigsService.GetGameServerConfig.
GetGameServerDeploymentRequest
Request message for GameServerDeploymentsService.GetGameServerDeployment.
GetGameServerDeploymentRolloutRequest
Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.
GetRealmRequest
Request message for RealmsService.GetRealm. .. attribute:: name
Required. The name of the realm to retrieve. Uses the form:
projects/{project}/locations/{location}/realms/{realm}.
:type: str
GkeClusterReference
A reference to a GKE cluster. .. attribute:: cluster
The full or partial name of a GKE cluster, using one of the following forms:
projects/{project}/locations/{location}/clusters/{cluster}locations/{location}/clusters/{cluster}{cluster}If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.:type: str
LabelSelector
The label selector, used to group labels on the resources. .. attribute:: labels
Resource labels for this selector.
:type: Sequence[google.cloud.gaming_v1beta.types.LabelSelector.LabelsEntry]
ListGameServerClustersRequest
Request message for GameServerClustersService.ListGameServerClusters.
ListGameServerClustersResponse
Response message for GameServerClustersService.ListGameServerClusters.
ListGameServerConfigsRequest
Request message for GameServerConfigsService.ListGameServerConfigs.
ListGameServerConfigsResponse
Response message for GameServerConfigsService.ListGameServerConfigs.
ListGameServerDeploymentsRequest
Request message for GameServerDeploymentsService.ListGameServerDeployments.
ListGameServerDeploymentsResponse
Response message for GameServerDeploymentsService.ListGameServerDeployments.
ListRealmsRequest
Request message for RealmsService.ListRealms. .. attribute:: parent
Required. The parent resource name. Uses the form:
projects/{project}/locations/{location}.
:type: str
ListRealmsResponse
Response message for RealmsService.ListRealms. .. attribute:: realms
The list of realms.
:type: Sequence[google.cloud.gaming_v1beta.types.Realm]
OperationMetadata
Represents the metadata of the long-running operation. .. attribute:: create_time
Output only. The time the operation was created.
:type: google.protobuf.timestamp_pb2.Timestamp
OperationStatus
PreviewCreateGameServerClusterRequest
Request message for GameServerClustersService.PreviewCreateGameServerCluster.
PreviewCreateGameServerClusterResponse
Response message for GameServerClustersService.PreviewCreateGameServerCluster.
PreviewDeleteGameServerClusterRequest
Request message for GameServerClustersService.PreviewDeleteGameServerCluster.
PreviewDeleteGameServerClusterResponse
Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
PreviewGameServerDeploymentRolloutRequest
Request message for PreviewGameServerDeploymentRollout. .. attribute:: rollout
Required. The game server deployment rollout to be updated. Only fields specified in update_mask are updated.
:type: google.cloud.gaming_v1beta.types.GameServerDeploymentRollout
PreviewGameServerDeploymentRolloutResponse
Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.
PreviewRealmUpdateRequest
Request message for RealmsService.PreviewRealmUpdate. .. attribute:: realm
Required. The realm to be updated. Only fields specified in update_mask are updated.
PreviewRealmUpdateResponse
Response message for RealmsService.PreviewRealmUpdate. .. attribute:: etag
ETag of the realm.
:type: str
PreviewUpdateGameServerClusterRequest
Request message for GameServerClustersService.UpdateGameServerCluster.
PreviewUpdateGameServerClusterResponse
Response message for GameServerClustersService.PreviewUpdateGameServerCluster
Realm
A realm resource. .. attribute:: name
The resource name of the realm. Uses the form:
projects/{project}/locations/{location}/realms/{realm}.
For example,
projects/my-project/locations/{location}/realms/my-realm.
:type: str
RealmSelector
The realm selector, used to match realm resources. .. attribute:: realms
List of realms to match.
:type: Sequence[str]
ScalingConfig
Autoscaling config for an Agones fleet. .. attribute:: name
Required. The name of the Scaling Config
:type: str
Schedule
The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring.
::
start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time
cron job: cron spec start time + duration
SpecSource
Encapsulates Agones fleet spec and Agones autoscaler spec sources.
TargetDetails
Details about the Agones resources. .. attribute:: game_server_cluster_name
The game server cluster name. Uses the form:
projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.
:type: str
TargetState
Encapsulates the Target state. .. attribute:: details
Details about Agones fleets.
:type: Sequence[google.cloud.gaming_v1beta.types.TargetDetails]
UpdateGameServerClusterRequest
Request message for GameServerClustersService.UpdateGameServerCluster.
UpdateGameServerDeploymentRequest
Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.
UpdateGameServerDeploymentRolloutRequest
Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.
UpdateRealmRequest
Request message for RealmsService.UpdateRealm. .. attribute:: realm
Required. The realm to be updated. Only fields specified in update_mask are updated.