Google Cloud Game Servers V1 Client - Class DeployedFleet (1.2.5)

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

Agones fleet specification and details.

Generated from protobuf message google.cloud.gaming.v1.DeployedFleetDetails.DeployedFleet

Namespace

Google \ Cloud \ Gaming \ V1 \ DeployedFleetDetails

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ fleet string

The name of the Agones fleet.

↳ fleet_spec string

The fleet spec retrieved from the Agones fleet.

↳ spec_source Google\Cloud\Gaming\V1\SpecSource

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

↳ status Google\Cloud\Gaming\V1\DeployedFleetDetails\DeployedFleet\DeployedFleetStatus

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

getFleet

The name of the Agones fleet.

Returns
Type Description
string

setFleet

The name of the Agones fleet.

Parameter
Name Description
var string
Returns
Type Description
$this

getFleetSpec

The fleet spec retrieved from the Agones fleet.

Returns
Type Description
string

setFleetSpec

The fleet spec retrieved from the Agones fleet.

Parameter
Name Description
var string
Returns
Type Description
$this

getSpecSource

The source spec that is used to create the Agones fleet.

The GameServerConfig resource may no longer exist in the system.

Returns
Type Description
Google\Cloud\Gaming\V1\SpecSource|null

hasSpecSource

clearSpecSource

setSpecSource

The source spec that is used to create the Agones fleet.

The GameServerConfig resource may no longer exist in the system.

Parameter
Name Description
var Google\Cloud\Gaming\V1\SpecSource
Returns
Type Description
$this

getStatus

The current status of the Agones fleet.

Includes count of game servers in various states.

Returns
Type Description
Google\Cloud\Gaming\V1\DeployedFleetDetails\DeployedFleet\DeployedFleetStatus|null

hasStatus

clearStatus

setStatus

The current status of the Agones fleet.

Includes count of game servers in various states.

Parameter
Name Description
var Google\Cloud\Gaming\V1\DeployedFleetDetails\DeployedFleet\DeployedFleetStatus
Returns
Type Description
$this