Class MultiplayFleetRegion

An association between the fleet and a region.

Inheritance

object

MultiplayFleetRegion

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.fleetRegion")]
[Preserve]
public class MultiplayFleetRegion

Constructors

MultiplayFleetRegion(long, long, string, long, long, string, string, bool, long, MultiplayFleetStatus)

Initializes a new instance of the MultiplayFleetRegion class.

Declaration

[Preserve]
public MultiplayFleetRegion(long deleteTTL = 0, long disabledDeleteTTL = 0, string id = null, long maxServers = 0, long minAvailableServers = 0, string regionID = null, string regionName = null, bool scalingEnabled = false, long shutdownTTL = 0, MultiplayFleetStatus status = (MultiplayFleetStatus)0)

Parameters

Type	Name	Description
long	deleteTTL	A delete time-to-live in seconds..
long	disabledDeleteTTL	A disabled delete time-to-live in seconds..
string	id	ID of the fleet region. (required).
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).
string	regionID	ID of the associated region. (required).
string	regionName	Name of the associated region. (required).
bool	scalingEnabled	Whether scaling is enabled for this fleet region. (required).
long	shutdownTTL	A shutdown time-to-live in seconds..
MultiplayFleetStatus	status	status (required).

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.

Id

ID of the fleet region.

Declaration

[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Id { get; set; }

Property Value

Type	Description
string	ID of the fleet region.

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.

RegionID

ID of the associated region.

Declaration

[DataMember(Name = "regionID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string RegionID { get; set; }

Property Value

Type	Description
string	ID of the associated region.

RegionName

Name of the associated region.

Declaration

[DataMember(Name = "regionName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string RegionName { get; set; }

Property Value

Type	Description
string	Name of the associated region.

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.

Status

Gets or Sets Status

Declaration

[DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayFleetStatus Status { get; set; }

Property Value

Type	Description
MultiplayFleetStatus