Class MultiplayFleetUpdateRegionRequest

Request to update the settings of a fleet region with the provided configuration.

Inheritance

object

MultiplayFleetUpdateRegionRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.Multiplay

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "multiplay.fleetUpdateRegionRequest")]
[Preserve]
public class MultiplayFleetUpdateRegionRequest

Constructors

MultiplayFleetUpdateRegionRequest(long, long, long, long, bool, long)

Initializes a new instance of the MultiplayFleetUpdateRegionRequest class.

Declaration

[Preserve]
public MultiplayFleetUpdateRegionRequest(long deleteTTL = 0, long disabledDeleteTTL = 0, long maxServers = 0, long minAvailableServers = 0, bool scalingEnabled = false, long shutdownTTL = 0)

Parameters

Type	Name	Description
long	deleteTTL	A delete time-to-live in seconds..
long	disabledDeleteTTL	A disabled delete time-to-live in seconds..
long	maxServers	Maximum number of servers to host in the fleet region. (required).
long	minAvailableServers	Minimum number of servers to keep free for new game sessions. (required).
bool	scalingEnabled	Whether scaling is enabled for this fleet region. (required).
long	shutdownTTL	A shutdown time-to-live in seconds..

Properties

DeleteTTL

A delete time-to-live in seconds.

Declaration

[DataMember(Name = "deleteTTL", EmitDefaultValue = false)]
[Preserve]
public long DeleteTTL { get; set; }

Property Value

Type	Description
long	A delete time-to-live in seconds.

DisabledDeleteTTL

A disabled delete time-to-live in seconds.

Declaration

[DataMember(Name = "disabledDeleteTTL", EmitDefaultValue = false)]
[Preserve]
public long DisabledDeleteTTL { get; set; }

Property Value

Type	Description
long	A disabled delete time-to-live in seconds.

MaxServers

Maximum number of servers to host in the fleet region.

Declaration

[DataMember(Name = "maxServers", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long MaxServers { get; set; }

Property Value

Type	Description
long	Maximum number of servers to host in the fleet region.

MinAvailableServers

Minimum number of servers to keep free for new game sessions.

Declaration

[DataMember(Name = "minAvailableServers", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long MinAvailableServers { get; set; }

Property Value

Type	Description
long	Minimum number of servers to keep free for new game sessions.

ScalingEnabled

Whether scaling is enabled for this fleet region.

Declaration

[DataMember(Name = "scalingEnabled", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public bool ScalingEnabled { get; set; }

Property Value

Type	Description
bool	Whether scaling is enabled for this fleet region.

ShutdownTTL

A shutdown time-to-live in seconds.

Declaration

[DataMember(Name = "shutdownTTL", EmitDefaultValue = false)]
[Preserve]
public long ShutdownTTL { get; set; }

Property Value

Type	Description
long	A shutdown time-to-live in seconds.