Class MultiplayFleet

A fleet of servers to host games.

Inheritance

object

MultiplayFleet

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

Constructors

MultiplayFleet(long, MultiplayAllocationType, List<MultiplayFleetBuildConfiguration>, long, long, List<MultiplayFleetRegion>, bool, string, string, OsFamilyEnum, string, string, MultiplayFleetServers, long, MultiplayFleetStatus, List<MultiplayFleetUsageSetting>)

Initializes a new instance of the MultiplayFleet class.

Declaration

[Preserve]
public MultiplayFleet(long allocationTTL = 0, MultiplayAllocationType allocationType = (MultiplayAllocationType)0, List<MultiplayFleetBuildConfiguration> buildConfigurations = null, long deleteTTL = 0, long disabledDeleteTTL = 0, List<MultiplayFleetRegion> fleetRegions = null, bool graceful = false, string id = null, string name = null, MultiplayFleet.OsFamilyEnum osFamily = (MultiplayFleet.OsFamilyEnum)0, string osID = null, string osName = null, MultiplayFleetServers servers = null, long shutdownTTL = 0, MultiplayFleetStatus status = (MultiplayFleetStatus)0, List<MultiplayFleetUsageSetting> usageSettings = null)

Parameters

Type	Name	Description
long	allocationTTL	The time in seconds that a game session can last before it is automatically deallocated. Game servers will be checked periodically to see if they have exceeded this timeout. .
MultiplayAllocationType	allocationType	allocationType (required).
List<MultiplayFleetBuildConfiguration>	buildConfigurations	A list of build configurations associated with the fleet. (required).
long	deleteTTL	A delete time-to-live in seconds..
long	disabledDeleteTTL	A disabled delete time-to-live in seconds..
List<MultiplayFleetRegion>	fleetRegions	A list of associations between the fleet and regions. (required).
bool	graceful	Boolean to indicate whether graceful stop is enabled for the fleet. Only valid for reservations-based fleets..
string	id	ID of the Fleet. (required).
string	name	Name of the fleet. (required).
MultiplayFleet.OsFamilyEnum	osFamily	The os family that the build is based on. (required).
string	osID	ID of the Operating System used in the fleet. (required).
string	osName	Name of the Operating System used in the fleet. (required).
MultiplayFleetServers	servers	servers (required).
long	shutdownTTL	A shutdown time-to-live in seconds..
MultiplayFleetStatus	status	status (required).
List<MultiplayFleetUsageSetting>	usageSettings	A list of usage settings associated with the fleet..

Properties

AllocationTTL

The time in seconds that a game session can last before it is automatically deallocated. Game servers will be checked periodically to see if they have exceeded this timeout.

Declaration

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

Property Value

Type	Description
long	The time in seconds that a game session can last before it is automatically deallocated. Game servers will be checked periodically to see if they have exceeded this timeout.

AllocationType

Gets or Sets AllocationType

Declaration

[DataMember(Name = "allocationType", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayAllocationType AllocationType { get; set; }

Property Value

Type	Description
MultiplayAllocationType

BuildConfigurations

A list of build configurations associated with the fleet.

Declaration

[DataMember(Name = "buildConfigurations", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<MultiplayFleetBuildConfiguration> BuildConfigurations { get; set; }

Property Value

Type	Description
List<MultiplayFleetBuildConfiguration>	A list of build configurations associated with the fleet.

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.

FleetRegions

A list of associations between the fleet and regions.

Declaration

[DataMember(Name = "fleetRegions", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<MultiplayFleetRegion> FleetRegions { get; set; }

Property Value

Type	Description
List<MultiplayFleetRegion>	A list of associations between the fleet and regions.

Graceful

Boolean to indicate whether graceful stop is enabled for the fleet. Only valid for reservations-based fleets.

Declaration

[DataMember(Name = "graceful", EmitDefaultValue = true)]
[Preserve]
public bool Graceful { get; set; }

Property Value

Type	Description
bool	Boolean to indicate whether graceful stop is enabled for the fleet. Only valid for reservations-based fleets.

Id

ID of the Fleet.

Declaration

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

Property Value

Type	Description
string	ID of the Fleet.

Name

Name of the fleet.

Declaration

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

Property Value

Type	Description
string	Name of the fleet.

OsFamily

The os family that the build is based on.

Declaration

[DataMember(Name = "osFamily", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayFleet.OsFamilyEnum OsFamily { get; set; }

Property Value

Type	Description
MultiplayFleet.OsFamilyEnum	The os family that the build is based on.

OsID

ID of the Operating System used in the fleet.

Declaration

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

Property Value

Type	Description
string	ID of the Operating System used in the fleet.

OsName

Name of the Operating System used in the fleet.

Declaration

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

Property Value

Type	Description
string	Name of the Operating System used in the fleet.

Servers

Gets or Sets Servers

Declaration

[DataMember(Name = "servers", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayFleetServers Servers { get; set; }

Property Value

Type	Description
MultiplayFleetServers

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

UsageSettings

A list of usage settings associated with the fleet.

Declaration

[DataMember(Name = "usageSettings", EmitDefaultValue = false)]
[Preserve]
public List<MultiplayFleetUsageSetting> UsageSettings { get; set; }

Property Value

Type	Description
List<MultiplayFleetUsageSetting>	A list of usage settings associated with the fleet.