Google Cloud Game Servers V1 Client - Class GameServerConfig (1.2.6)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class GameServerConfig.

A game server config resource.

Generated from protobuf message google.cloud.gaming.v1.GameServerConfig

Namespace

Google \ Cloud \ Gaming \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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`.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The creation time.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The last-modified time.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` The labels associated with this game server config. Each label is a key-value pair.
`↳ fleet_configs`	`array<Google\Cloud\Gaming\V1\FleetConfig>` FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed.
`↳ scaling_configs`	`array<Google\Cloud\Gaming\V1\ScalingConfig>` The autoscaling settings.
`↳ description`	`string` The description of the game server config.

getName

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.

Returns
Type	Description
`string`

setName

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The last-modified time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getFleetConfigs

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setFleetConfigs

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

Parameter
Name	Description
`var`	`array<Google\Cloud\Gaming\V1\FleetConfig>`

Returns
Type	Description
`$this`

getScalingConfigs

The autoscaling settings.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setScalingConfigs

The autoscaling settings.

Parameter
Name	Description
`var`	`array<Google\Cloud\Gaming\V1\ScalingConfig>`

Returns
Type	Description
`$this`

getDescription

The description of the game server config.

Returns
Type	Description
`string`

setDescription

The description of the game server config.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`