Google Cloud Game Servers V1 Client - Class DeployedFleetStatus (1.0.5)

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

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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ ready_replicas int|string

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

↳ allocated_replicas int|string

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

↳ reserved_replicas int|string

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.

↳ replicas int|string

The total number of current GameServer replicas in this fleet.

getReadyReplicas

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

Returns
TypeDescription
int|string

setReadyReplicas

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getAllocatedReplicas

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

Returns
TypeDescription
int|string

setAllocatedReplicas

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getReservedReplicas

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.

Returns
TypeDescription
int|string

setReservedReplicas

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getReplicas

The total number of current GameServer replicas in this fleet.

Returns
TypeDescription
int|string

setReplicas

The total number of current GameServer replicas in this fleet.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this