REST Resource: projects.locations.gameServerDeployments.configs

Resource: GameServerConfig

A game server config resource.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "fleetConfigs": [
    {
      object (FleetConfig)
    }
  ],
  "scalingConfigs": [
    {
      object (ScalingConfig)
    }
  ],
  "description": string
}
Fields
name

string

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.

createTime

string (Timestamp format)

Output only. The creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The last-modified time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

fleetConfigs[]

object (FleetConfig)

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

scalingConfigs[]

object (ScalingConfig)

The autoscaling settings.

description

string

The description of the game server config.

FleetConfig

Fleet configs for Agones.

JSON representation
{
  "fleetSpec": string,
  "name": string
}
Fields
fleetSpec

string

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

name

string

The name of the FleetConfig.

ScalingConfig

Autoscaling config for an Agones fleet.

JSON representation
{
  "name": string,
  "fleetAutoscalerSpec": string,
  "selectors": [
    {
      object (LabelSelector)
    }
  ],
  "schedules": [
    {
      object (Schedule)
    }
  ]
}
Fields
name

string

Required. The name of the Scaling Config

fleetAutoscalerSpec

string

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

selectors[]

object (LabelSelector)

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.

schedules[]

object (Schedule)

The schedules to which this Scaling Config applies.

LabelSelector

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

JSON representation
{
  "labels": {
    string: string,
    ...
  }
}
Fields
labels

map (key: string, value: string)

Resource labels for this selector.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Schedule

The schedule of a recurring or one time event. The event's time span is specified by startTime and endTime. If the scheduled event's timespan is larger than the cronSpec + cronJobDuration, the event will be recurring. If only cronSpec + cronJobDuration are specified, the event is effective starting at the local time specified by cronSpec, and is recurring.

startTime|-------[cron job]-------[cron job]-------[cron job]---|endTime cron job: cron spec start time + duration

JSON representation
{
  "startTime": string,
  "endTime": string,
  "cronJobDuration": string,
  "cronSpec": string
}
Fields
startTime

string (Timestamp format)

The start time of the event.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The end time of the event.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

cronJobDuration

string (Duration format)

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

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

cronSpec

string

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.

Methods

create

Creates a new game server config in a given project, location, and game server deployment.

delete

Deletes a single game server config.

get

Gets details of a single game server config.

list

Lists game server configs in a given project, location, and game server deployment.