Class MultiplayFleetCreateRequest

Request to create a fleet with the provided configuration.

Inheritance

object

MultiplayFleetCreateRequest

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

Constructors

MultiplayFleetCreateRequest(MultiplayCreateAllocationType?, List<long>, bool, string, OsFamilyEnum?, string, List<MultiplayFleetCreateRequestRegion>, List<MultiplayFleetUsageSetting>)

Initializes a new instance of the MultiplayFleetCreateRequest class.

Declaration

[Preserve]
public MultiplayFleetCreateRequest(MultiplayCreateAllocationType? allocationType = null, List<long> buildConfigurations = null, bool graceful = false, string name = null, MultiplayFleetCreateRequest.OsFamilyEnum? osFamily = null, string osID = null, List<MultiplayFleetCreateRequestRegion> regions = null, List<MultiplayFleetUsageSetting> usageSettings = null)

Parameters

Type	Name	Description
MultiplayCreateAllocationType?	allocationType	allocationType.
List<long>	buildConfigurations	A list of build configuration IDs to associate with the fleet. (required).
bool	graceful	Boolean to indicate whether graceful stop is enabled for the fleet. Only valid for reservations-based fleets..
string	name	Name of the fleet. (required).
MultiplayFleetCreateRequest.OsFamilyEnum?	osFamily	The os family that the build is based on..
string	osID	ID of the Operating System used in the fleet..
List<MultiplayFleetCreateRequestRegion>	regions	A list of region associations to create. (required).
List<MultiplayFleetUsageSetting>	usageSettings	A list of usage settings associated with the fleet..

Properties

AllocationType

Gets or Sets AllocationType

Declaration

[DataMember(Name = "allocationType", EmitDefaultValue = false)]
[Preserve]
public MultiplayCreateAllocationType? AllocationType { get; set; }

Property Value

Type	Description
MultiplayCreateAllocationType?

BuildConfigurations

A list of build configuration IDs to associate with the fleet.

Declaration

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

Property Value

Type	Description
List<long>	A list of build configuration IDs to associate 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.

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", EmitDefaultValue = false)]
[Preserve]
public MultiplayFleetCreateRequest.OsFamilyEnum? OsFamily { get; set; }

Property Value

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

OsID

ID of the Operating System used in the fleet.

Declaration

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

Property Value

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

Regions

A list of region associations to create.

Declaration

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

Property Value

Type	Description
List<MultiplayFleetCreateRequestRegion>	A list of region associations to create.

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.