Class MultiplayFleetUpdateRequest

Request to update a fleet with the provided configuration.

Inheritance

object

MultiplayFleetUpdateRequest

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

Constructors

MultiplayFleetUpdateRequest(long, List<long>, long, long, bool, string, string, long, List<MultiplayFleetUsageSetting>)

Initializes a new instance of the MultiplayFleetUpdateRequest class.

Declaration

[Preserve]
public MultiplayFleetUpdateRequest(long allocationTTL = 0, List<long> buildConfigurations = null, long deleteTTL = 0, long disabledDeleteTTL = 0, bool graceful = false, string name = null, string osID = null, long shutdownTTL = 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. .
List<long>	buildConfigurations	A list of build configuration IDs to associate with the fleet. (required).
long	deleteTTL	A delete time-to-live in seconds..
long	disabledDeleteTTL	A disabled delete time-to-live in seconds..
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).
string	osID	ID of the Operating System used in the fleet. (required).
long	shutdownTTL	A shutdown time-to-live in seconds..
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.

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.

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.

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.

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.

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.

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.