Class MultiplayFleetListItem

A fleet for managing game servers and machines.

Inheritance

object

MultiplayFleetListItem

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

Constructors

MultiplayFleetListItem(MultiplayAllocationType, List<BuildConfiguration>, bool, string, string, string, string, List<FleetRegion>, MultiplayFleetServers, MultiplayFleetStatus, List<MultiplayFleetUsageSetting>)

Initializes a new instance of the MultiplayFleetListItem class.

Declaration

[Preserve]
public MultiplayFleetListItem(MultiplayAllocationType allocationType = (MultiplayAllocationType)0, List<BuildConfiguration> buildConfigurations = null, bool graceful = false, string id = null, string name = null, string osID = null, string osName = null, List<FleetRegion> regions = null, MultiplayFleetServers servers = null, MultiplayFleetStatus status = (MultiplayFleetStatus)0, List<MultiplayFleetUsageSetting> usageSettings = null)

Parameters

Type	Name	Description
MultiplayAllocationType	allocationType	allocationType (required).
List<BuildConfiguration>	buildConfigurations	A list of build configurations associated with the fleet. (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).
string	osID	ID of the Operating System used in the fleet. (required).
string	osName	Name of the Operating System used in the fleet. (required).
List<FleetRegion>	regions	A list regions associated with the fleet. (required).
MultiplayFleetServers	servers	servers (required).
MultiplayFleetStatus	status	status (required).
List<MultiplayFleetUsageSetting>	usageSettings	A list of usage settings associated with the fleet..

Properties

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<BuildConfiguration> BuildConfigurations { get; set; }

Property Value

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

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.

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.

Regions

A list regions associated with the fleet.

Declaration

[DataMember(Name = "regions", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<FleetRegion> Regions { get; set; }

Property Value

Type	Description
List<FleetRegion>	A list regions associated with 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

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.