As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Gaming v1 API¶

class google.cloud.gaming_v1.types.CreateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.CreateGameServerCluster.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.

Type: str

game_server_cluster_id¶

Required. The ID of the game server cluster resource to be created.

Type: str

game_server_cluster¶

Required. The game server cluster resource to be created.

Type: google.cloud.gaming_v1.types.GameServerCluster

class google.cloud.gaming_v1.types.CreateGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerConfigsService.CreateGameServerConfig.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

Type: str

config_id¶

Required. The ID of the game server config resource to be created.

Type: str

game_server_config¶

Required. The game server config resource to be created.

Type: google.cloud.gaming_v1.types.GameServerConfig

class google.cloud.gaming_v1.types.CreateGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.CreateGameServerDeployment.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Type: str

deployment_id¶

Required. The ID of the game server delpoyment resource to be created.

Type: str

game_server_deployment¶

Required. The game server delpoyment resource to be created.

Type: google.cloud.gaming_v1.types.GameServerDeployment

class google.cloud.gaming_v1.types.CreateRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.CreateRealm.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Type: str

realm_id¶

Required. The ID of the realm resource to be created.

Type: str

realm¶

Required. The realm resource to be created.

Type: google.cloud.gaming_v1.types.Realm

class google.cloud.gaming_v1.types.DeleteGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.DeleteGameServerCluster.

name¶

Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

Type: str

class google.cloud.gaming_v1.types.DeleteGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerConfigsService.DeleteGameServerConfig.

name¶

Required. The name of the game server config to delete, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

Type: str

class google.cloud.gaming_v1.types.DeleteGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

name¶

Required. The name of the game server delpoyment to delete, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Type: str

class google.cloud.gaming_v1.types.DeleteRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.DeleteRealm.

name¶

Required. The name of the realm to delete, in the following form: projects/{project}/locations/{location}/realms/{realm}.

Type: str

class google.cloud.gaming_v1.types.DeployedFleetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details of the deployed Agones fleet.

deployed_fleet¶

Information about the Agones fleet.

Type: google.cloud.gaming_v1.types.DeployedFleetDetails.DeployedFleet

deployed_autoscaler¶

Information about the Agones autoscaler for that fleet.

Type: google.cloud.gaming_v1.types.DeployedFleetDetails.DeployedFleetAutoscaler

class DeployedFleet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Agones fleet specification and details.

fleet¶

The name of the Agones fleet.

Type: str

fleet_spec¶

The fleet spec retrieved from the Agones fleet.

Type: str

spec_source¶

The source spec that is used to create the Agones fleet. The GameServerConfig resource may no longer exist in the system.

Type: google.cloud.gaming_v1.types.SpecSource

status¶

The current status of the Agones fleet. Includes count of game servers in various states.

Type: google.cloud.gaming_v1.types.DeployedFleetDetails.DeployedFleet.DeployedFleetStatus

class DeployedFleetStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

DeployedFleetStatus has details about the Agones fleets such as how many are running, how many allocated, and so on.

ready_replicas¶

The number of GameServer replicas in the READY state in this fleet.

Type: int

allocated_replicas¶

The number of GameServer replicas in the ALLOCATED state in this fleet.

Type: int

reserved_replicas¶

The number of GameServer replicas in the RESERVED state in this fleet. Reserved instances won’t be deleted on scale down, but won’t cause an autoscaler to scale up.

Type: int

replicas¶

The total number of current GameServer replicas in this fleet.

Type: int

class DeployedFleetAutoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details about the Agones autoscaler.

autoscaler¶

The name of the Agones autoscaler.

Type: str

spec_source¶

The source spec that is used to create the autoscaler. The GameServerConfig resource may no longer exist in the system.

Type: google.cloud.gaming_v1.types.SpecSource

fleet_autoscaler_spec¶

The autoscaler spec retrieved from Agones.

Type: str

class google.cloud.gaming_v1.types.FetchDeploymentStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.FetchDeploymentState.

name¶

Required. The name of the game server delpoyment, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Type: str

class google.cloud.gaming_v1.types.FetchDeploymentStateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerDeploymentsService.FetchDeploymentState.

cluster_state¶

The state of the game server deployment in each game server cluster.

Type: MutableSequence[google.cloud.gaming_v1.types.FetchDeploymentStateResponse.DeployedClusterState]

unavailable¶

List of locations that could not be reached.

Type: MutableSequence[str]

class DeployedClusterState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The game server cluster changes made by the game server deployment.

cluster¶

The name of the cluster.

Type: str

fleet_details¶

The details about the Agones fleets and autoscalers created in the game server cluster.

Type: MutableSequence[google.cloud.gaming_v1.types.DeployedFleetDetails]

class google.cloud.gaming_v1.types.FleetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Fleet configs for Agones.

fleet_spec¶

Agones fleet spec. Example spec: https://agones.dev/site/docs/reference/fleet/.

Type: str

name¶

The name of the FleetConfig.

Type: str

class google.cloud.gaming_v1.types.GameServerCluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A game server cluster resource.

name¶

Required. The resource name of the game server cluster, in the following form: projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}. For example, projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster.

Type: str

create_time¶

Output only. The creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The last-modified time.

Type: google.protobuf.timestamp_pb2.Timestamp

labels¶

The labels associated with this game server cluster. Each label is a key-value pair.

Type: MutableMapping[str, str]

connection_info¶

The game server cluster connection information. This information is used to manage game server clusters.

Type: google.cloud.gaming_v1.types.GameServerClusterConnectionInfo

etag¶

ETag of the resource.

Type: str

description¶

Human readable description of the cluster.

Type: str

cluster_state¶

Output only. The state of the Kubernetes cluster, this will be available if ‘view’ is set to FULL in the relevant List/Get/Preview request.

Type: google.cloud.gaming_v1.types.KubernetesClusterState

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.GameServerClusterConnectionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The game server cluster connection information.

gke_cluster_reference¶

Reference to the GKE cluster where the game servers are installed.

This field is a member of oneof cluster_reference.

Type: google.cloud.gaming_v1.types.GkeClusterReference

namespace¶

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

Type: str

class google.cloud.gaming_v1.types.GameServerClusterView(value)[source]¶

Bases: proto.enums.Enum

A view for GameServerCluster objects.

Values:

GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED (0):: The default / unset value. The API will default to the BASIC view.
BASIC (1):: Include basic information of a GameServerCluster resource and omit cluster_state. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster).
FULL (2):: Include everything.

class google.cloud.gaming_v1.types.GameServerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A game server config resource.

name¶

The resource name of the game server config, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}. For example, projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.

Type: str

create_time¶

Output only. The creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The last-modified time.

Type: google.protobuf.timestamp_pb2.Timestamp

labels¶

The labels associated with this game server config. Each label is a key-value pair.

Type: MutableMapping[str, str]

fleet_configs¶

FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed.

Type: MutableSequence[google.cloud.gaming_v1.types.FleetConfig]

scaling_configs¶

The autoscaling settings.

Type: MutableSequence[google.cloud.gaming_v1.types.ScalingConfig]

description¶

The description of the game server config.

Type: str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.GameServerConfigOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A game server config override.

realms_selector¶

Selector for choosing applicable realms.

This field is a member of oneof selector.

Type: google.cloud.gaming_v1.types.RealmSelector

config_version¶

The game server config for this override.

This field is a member of oneof change.

Type: str

class google.cloud.gaming_v1.types.GameServerDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A game server deployment resource.

name¶

The resource name of the game server deployment, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}. For example, projects/my-project/locations/global/gameServerDeployments/my-deployment.

Type: str

create_time¶

Output only. The creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The last-modified time.

Type: google.protobuf.timestamp_pb2.Timestamp

labels¶

The labels associated with this game server deployment. Each label is a key-value pair.

Type: MutableMapping[str, str]

etag¶

ETag of the resource.

Type: str

description¶

Human readable description of the game server delpoyment.

Type: str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.GameServerDeploymentRollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The game server deployment rollout which represents the desired rollout state.

name¶

The resource name of the game server deployment rollout, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout. For example, projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout.

Type: str

create_time¶

Output only. The creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The last-modified time.

Type: google.protobuf.timestamp_pb2.Timestamp

default_game_server_config¶

The default game server config is applied to all realms unless overridden in the rollout. For example, projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.

Type: str

game_server_config_overrides¶

Contains the game server config rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a realm, the rest of the list is not processed.

Type: MutableSequence[google.cloud.gaming_v1.types.GameServerConfigOverride]

etag¶

ETag of the resource.

Type: str

class google.cloud.gaming_v1.types.GetGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.GetGameServerCluster.

name¶

Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

Type: str

view¶

Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Type: google.cloud.gaming_v1.types.GameServerClusterView

class google.cloud.gaming_v1.types.GetGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerConfigsService.GetGameServerConfig.

name¶

Required. The name of the game server config to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

Type: str

class google.cloud.gaming_v1.types.GetGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.GetGameServerDeployment.

name¶

Required. The name of the game server delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Type: str

class google.cloud.gaming_v1.types.GetGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

name¶

Required. The name of the game server delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

Type: str

class google.cloud.gaming_v1.types.GetRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.GetRealm.

name¶

Required. The name of the realm to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm}.

Type: str

class google.cloud.gaming_v1.types.GkeClusterReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A reference to a GKE cluster.

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

class google.cloud.gaming_v1.types.KubernetesClusterState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The state of the Kubernetes cluster.

agones_version_installed¶

Output only. The version of Agones currently installed in the registered Kubernetes cluster.

Type: str

kubernetes_version_installed¶

Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

Type: str

installation_state¶

Output only. The state for the installed versions of Agones/Kubernetes.

Type: google.cloud.gaming_v1.types.KubernetesClusterState.InstallationState

version_installed_error_message¶

Output only. The detailed error message for the installed versions of Agones/Kubernetes.

Type: str

provider¶

Output only. The cloud provider type reported by the first node’s providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

Type: str

agones_version_targeted¶

Output only. The version of Agones that is targeted to be installed in the cluster.

Type: str

class InstallationState(value)[source]¶

Bases: proto.enums.Enum

The state of the installed versions of Agones/Kubernetes. See also https://cloud.google.com/game-servers/docs/versions-and-upgrades.

Values:

INSTALLATION_STATE_UNSPECIFIED (0):: The default value. This value is used if the state is omitted.
AGONES_KUBERNETES_VERSION_SUPPORTED (1):: The combination of Agones and Kubernetes versions is supported by Google Cloud Game Servers.
AGONES_VERSION_UNSUPPORTED (2):: The installed version of Agones is not supported by Google Cloud Game Servers.
AGONES_KUBERNETES_VERSION_UNSUPPORTED (3):: The installed version of Agones is supported by Google Cloud Game Servers, but the installed version of Kubernetes is not recommended or supported by the version of Agones.
AGONES_VERSION_UNRECOGNIZED (4):: The installed version of Agones is not recognized because the Agones controller’s image name does not have a version string reported as {major}.{minor}(.{patch}).
KUBERNETES_VERSION_UNRECOGNIZED (5):: The server version of Kubernetes cluster is not recognized because the API server didn’t return parsable version info on path/version.
VERSION_VERIFICATION_FAILED (6):: Failed to read or verify the version of Agones or Kubernetes. See version_installed_error_message for details.
AGONES_NOT_INSTALLED (7):: Agones is not installed.

class google.cloud.gaming_v1.types.LabelSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The label selector, used to group labels on the resources.

labels¶

Resource labels for this selector.

Type: MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.ListGameServerClustersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.ListGameServerClusters.

parent¶

Required. The parent resource name, in the following form: “projects/{project}/locations/{location}/realms/{realm}”.

Type: str

page_size¶

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1.ListGameServerClustersResponse.next_page_token] to determine if there are more GameServerClusters left to be queried.

Type: int

page_token¶

Optional. The next_page_token value returned from a previous List request, if any.

Type: str

filter¶

Optional. The filter to apply to list results.

Type: str

order_by¶

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Type: str

view¶

Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Type: google.cloud.gaming_v1.types.GameServerClusterView

class google.cloud.gaming_v1.types.ListGameServerClustersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerClustersService.ListGameServerClusters.

game_server_clusters¶

The list of game server clusters.

Type: MutableSequence[google.cloud.gaming_v1.types.GameServerCluster]

next_page_token¶

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type: str

unreachable¶

List of locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.gaming_v1.types.ListGameServerConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerConfigsService.ListGameServerConfigs.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

Type: str

page_size¶

Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1.ListGameServerConfigsResponse.next_page_token] to determine if there are more GameServerConfigs left to be queried.

Type: int

page_token¶

Optional. The next_page_token value returned from a previous list request, if any.

Type: str

filter¶

Optional. The filter to apply to list results.

Type: str

order_by¶

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Type: str

class google.cloud.gaming_v1.types.ListGameServerConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerConfigsService.ListGameServerConfigs.

game_server_configs¶

The list of game server configs.

Type: MutableSequence[google.cloud.gaming_v1.types.GameServerConfig]

next_page_token¶

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type: str

unreachable¶

List of locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.gaming_v1.types.ListGameServerDeploymentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.ListGameServerDeployments.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Type: str

page_size¶

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1.ListGameServerDeploymentsResponse.next_page_token] to determine if there are more GameServerDeployments left to be queried.

Type: int

page_token¶

Optional. The next_page_token value returned from a previous List request, if any.

Type: str

filter¶

Optional. The filter to apply to list results.

Type: str

order_by¶

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Type: str

class google.cloud.gaming_v1.types.ListGameServerDeploymentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerDeploymentsService.ListGameServerDeployments.

game_server_deployments¶

The list of game server deployments.

Type: MutableSequence[google.cloud.gaming_v1.types.GameServerDeployment]

next_page_token¶

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type: str

unreachable¶

List of locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.gaming_v1.types.ListRealmsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.ListRealms.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Type: str

page_size¶

Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1.ListRealmsResponse.next_page_token] to determine if there are more realms left to be queried.

Type: int

page_token¶

Optional. The next_page_token value returned from a previous List request, if any.

Type: str

filter¶

Optional. The filter to apply to list results.

Type: str

order_by¶

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Type: str

class google.cloud.gaming_v1.types.ListRealmsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for RealmsService.ListRealms.

realms¶

The list of realms.

Type: MutableSequence[google.cloud.gaming_v1.types.Realm]

next_page_token¶

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type: str

unreachable¶

List of locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.gaming_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the metadata of the long-running operation.

create_time¶

Output only. The time the operation was created.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

Output only. The time the operation finished running.

Type: google.protobuf.timestamp_pb2.Timestamp

target¶

Output only. Server-defined resource path for the target of the operation.

Type: str

verb¶

Output only. Name of the verb executed by the operation.

Type: str

status_message¶

Output only. Human-readable status of the operation, if any.

Type: str

requested_cancellation¶

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type: bool

api_version¶

Output only. API version used to start the operation.

Type: str

unreachable¶

Output only. List of Locations that could not be reached.

Type: MutableSequence[str]

operation_status¶

Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.

Type: MutableMapping[str, google.cloud.gaming_v1.types.OperationStatus]

class OperationStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.OperationStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

done¶

Output only. Whether the operation is done or still in progress.

Type: bool

error_code¶

The error code in case of failures.

Type: google.cloud.gaming_v1.types.OperationStatus.ErrorCode

error_message¶

The human-readable error message.

Type: str

class ErrorCode(value)[source]¶

Bases: proto.enums.Enum

Values:

ERROR_CODE_UNSPECIFIED (0):: No description available.
INTERNAL_ERROR (1):: No description available.
PERMISSION_DENIED (2):: No description available.
CLUSTER_CONNECTION (3):: No description available.

class google.cloud.gaming_v1.types.PreviewCreateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.PreviewCreateGameServerCluster.

parent¶

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm}.

Type: str

game_server_cluster_id¶

Required. The ID of the game server cluster resource to be created.

Type: str

game_server_cluster¶

Required. The game server cluster resource to be created.

Type: google.cloud.gaming_v1.types.GameServerCluster

preview_time¶

Optional. The target timestamp to compute the preview.

Type: google.protobuf.timestamp_pb2.Timestamp

view¶

Optional. This field is deprecated, preview will always return KubernetesClusterState.

Type: google.cloud.gaming_v1.types.GameServerClusterView

class google.cloud.gaming_v1.types.PreviewCreateGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerClustersService.PreviewCreateGameServerCluster.

etag¶

The ETag of the game server cluster.

Type: str

target_state¶

The target state.

Type: google.cloud.gaming_v1.types.TargetState

cluster_state¶

Output only. The state of the Kubernetes cluster in preview, this will be available if ‘view’ is set to FULL in the relevant List/Get/Preview request.

Type: google.cloud.gaming_v1.types.KubernetesClusterState

class google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.PreviewDeleteGameServerCluster.

name¶

Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

Type: str

preview_time¶

Optional. The target timestamp to compute the preview.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

etag¶

The ETag of the game server cluster.

Type: str

target_state¶

The target state.

Type: google.cloud.gaming_v1.types.TargetState

class google.cloud.gaming_v1.types.PreviewGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for PreviewGameServerDeploymentRollout.

rollout¶

Required. The game server deployment rollout to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.GameServerDeploymentRollout

update_mask¶

Optional. 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

Type: google.protobuf.field_mask_pb2.FieldMask

preview_time¶

Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.gaming_v1.types.PreviewGameServerDeploymentRolloutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.

unavailable¶

Locations that could not be reached on this request.

Type: MutableSequence[str]

etag¶

ETag of the game server deployment.

Type: str

target_state¶

The target state.

Type: google.cloud.gaming_v1.types.TargetState

class google.cloud.gaming_v1.types.PreviewRealmUpdateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.PreviewRealmUpdate.

realm¶

Required. The realm to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.Realm

update_mask¶

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Type: google.protobuf.field_mask_pb2.FieldMask

preview_time¶

Optional. The target timestamp to compute the preview.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.gaming_v1.types.PreviewRealmUpdateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for RealmsService.PreviewRealmUpdate.

etag¶

ETag of the realm.

Type: str

target_state¶

The target state.

Type: google.cloud.gaming_v1.types.TargetState

class google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.UpdateGameServerCluster.

game_server_cluster¶

Required. The game server cluster to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.GameServerCluster

update_mask¶

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

Type: google.protobuf.field_mask_pb2.FieldMask

preview_time¶

Optional. The target timestamp to compute the preview.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for GameServerClustersService.PreviewUpdateGameServerCluster

etag¶

The ETag of the game server cluster.

Type: str

target_state¶

The target state.

Type: google.cloud.gaming_v1.types.TargetState

class google.cloud.gaming_v1.types.Realm(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A realm resource.

name¶

The resource name of the realm, in the following form: projects/{project}/locations/{location}/realms/{realm}. For example, projects/my-project/locations/{location}/realms/my-realm.

Type: str

create_time¶

Output only. The creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The last-modified time.

Type: google.protobuf.timestamp_pb2.Timestamp

labels¶

The labels associated with this realm. Each label is a key-value pair.

Type: MutableMapping[str, str]

time_zone¶

Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

Type: str

etag¶

ETag of the resource.

Type: str

description¶

Human readable description of the realm.

Type: str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.gaming_v1.types.RealmSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The realm selector, used to match realm resources.

realms¶

List of realms to match.

Type: MutableSequence[str]

class google.cloud.gaming_v1.types.ScalingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Autoscaling config for an Agones fleet.

name¶

Required. The name of the Scaling Config

Type: str

fleet_autoscaler_spec¶

Required. Agones fleet autoscaler spec. Example spec: https://agones.dev/site/docs/reference/fleetautoscaler/

Type: str

selectors¶

Labels used to identify the game server clusters to which this Agones scaling config applies. A game server cluster is subject to this Agones scaling config if its labels match any of the selector entries.

Type: MutableSequence[google.cloud.gaming_v1.types.LabelSelector]

schedules¶

The schedules to which this Scaling Config applies.

Type: MutableSequence[google.cloud.gaming_v1.types.Schedule]

class google.cloud.gaming_v1.types.Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

start_time¶

The start time of the event.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

The end time of the event.

Type: google.protobuf.timestamp_pb2.Timestamp

cron_job_duration¶

The duration for the cron job event. The duration of the event is effective after the cron job’s start time.

Type: google.protobuf.duration_pb2.Duration

cron_spec¶

The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm.

Type: str

class google.cloud.gaming_v1.types.SpecSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Encapsulates Agones fleet spec and Agones autoscaler spec sources.

game_server_config_name¶

The game server config resource. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}.

Type: str

name¶

The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Type: str

class google.cloud.gaming_v1.types.TargetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details about the Agones resources.

game_server_cluster_name¶

The game server cluster name. Uses the form: projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.

Type: str

game_server_deployment_name¶

The game server deployment name. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}.

Type: str

fleet_details¶

Agones fleet details for game server clusters and game server deployments.

Type: MutableSequence[google.cloud.gaming_v1.types.TargetDetails.TargetFleetDetails]

class TargetFleetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details of the target Agones fleet.

fleet¶

Reference to target Agones fleet.

Type: google.cloud.gaming_v1.types.TargetDetails.TargetFleetDetails.TargetFleet

autoscaler¶

Reference to target Agones fleet autoscaling policy.

Type: google.cloud.gaming_v1.types.TargetDetails.TargetFleetDetails.TargetFleetAutoscaler

class TargetFleet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Target Agones fleet specification.

name¶

The name of the Agones fleet.

Type: str

spec_source¶

Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

Type: google.cloud.gaming_v1.types.SpecSource

class TargetFleetAutoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Target Agones autoscaler policy reference.

name¶

The name of the Agones autoscaler.

Type: str

spec_source¶

Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

Type: google.cloud.gaming_v1.types.SpecSource

class google.cloud.gaming_v1.types.TargetState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Encapsulates the Target state.

details¶

Details about Agones fleets.

Type: MutableSequence[google.cloud.gaming_v1.types.TargetDetails]

class google.cloud.gaming_v1.types.UpdateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerClustersService.UpdateGameServerCluster.

game_server_cluster¶

Required. The game server cluster to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.GameServerCluster

update_mask¶

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

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.gaming_v1.types.UpdateGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

Type: google.cloud.gaming_v1.types.GameServerDeployment

update_mask¶

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

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.gaming_v1.types.UpdateGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

rollout¶

Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.GameServerDeploymentRollout

update_mask¶

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

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.gaming_v1.types.UpdateRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for RealmsService.UpdateRealm.

realm¶

Required. The realm to be updated. Only fields specified in update_mask are updated.

Type: google.cloud.gaming_v1.types.Realm

update_mask¶

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Type: google.protobuf.field_mask_pb2.FieldMask

Types for Google Cloud Gaming v1 API¶

google-cloud-game-servers

Navigation

Related Topics