Class MultiplayBuildConfiguration

A build configuration for configuring game builds to run on servers.

Inheritance

object

MultiplayBuildConfiguration

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

Constructors

MultiplayBuildConfiguration(string, long, string, string, List<MultiplayBuildConfigurationConfigPair>, long, DateTime, string, string, long, long, string, string, bool, long, DateTime, long)

Initializes a new instance of the MultiplayBuildConfiguration class.

Declaration

[Preserve]
public MultiplayBuildConfiguration(string binaryPath = null, long buildID = 0, string buildName = null, string commandLine = null, List<MultiplayBuildConfigurationConfigPair> configuration = null, long cores = 0, DateTime createdAt = default, string fleetID = null, string fleetName = null, long id = 0, long memory = 0, string name = null, string queryType = null, bool readiness = false, long speed = 0, DateTime updatedAt = default, long version = 0)

Parameters

Type	Name	Description
string	binaryPath	Path to the game binary. (required).
long	buildID	ID of the build associated with the build configuration. (required).
string	buildName	Name of the build associated with the build configuration. (required).
string	commandLine	Binary launch parameters. (required).
List<MultiplayBuildConfigurationConfigPair>	configuration	A list of key/value pairs used to configure the associated build. Replaces configuration tokens from v3. (required).
long	cores	The number of CPU cores required per server. (required).
DateTime	createdAt	Date of creation. (required).
string	fleetID	ID of the fleet associated with the build configuration..
string	fleetName	Name of the fleet associated with the build configuration..
long	id	ID of the build configuration. (required).
long	memory	Maximum memory required per server. (required).
string	name	Name of the build configuration. (required).
string	queryType	Query type supported by this build configuration. (required).
bool	readiness	A boolean to indicate allocation readiness status. (required).
long	speed	CPU utilisation per core. (required).
DateTime	updatedAt	Date of last update. (required).
long	version	Version of the build configuration (required).

Properties

BinaryPath

Path to the game binary.

Declaration

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

Property Value

Type	Description
string	Path to the game binary.

BuildID

ID of the build associated with the build configuration.

Declaration

[DataMember(Name = "buildID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long BuildID { get; set; }

Property Value

Type	Description
long	ID of the build associated with the build configuration.

BuildName

Name of the build associated with the build configuration.

Declaration

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

Property Value

Type	Description
string	Name of the build associated with the build configuration.

CommandLine

Binary launch parameters.

Declaration

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

Property Value

Type	Description
string	Binary launch parameters.

Cores

The number of CPU cores required per server.

Declaration

[DataMember(Name = "cores", IsRequired = true, EmitDefaultValue = true)]
[Obsolete]
[Preserve]
public long Cores { get; set; }

Property Value

Type	Description
long	The number of CPU cores required per server.

CreatedAt

Date of creation.

Declaration

[DataMember(Name = "createdAt", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public DateTime CreatedAt { get; set; }

Property Value

Type	Description
DateTime	Date of creation.

FleetID

ID of the fleet associated with the build configuration.

Declaration

[DataMember(Name = "fleetID", EmitDefaultValue = false)]
[Preserve]
public string FleetID { get; set; }

Property Value

Type	Description
string	ID of the fleet associated with the build configuration.

FleetName

Name of the fleet associated with the build configuration.

Declaration

[DataMember(Name = "fleetName", EmitDefaultValue = false)]
[Preserve]
public string FleetName { get; set; }

Property Value

Type	Description
string	Name of the fleet associated with the build configuration.

Id

ID of the build configuration.

Declaration

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

Property Value

Type	Description
long	ID of the build configuration.

Memory

Maximum memory required per server.

Declaration

[DataMember(Name = "memory", IsRequired = true, EmitDefaultValue = true)]
[Obsolete]
[Preserve]
public long Memory { get; set; }

Property Value

Type	Description
long	Maximum memory required per server.

Name

Name of the build configuration.

Declaration

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

Property Value

Type	Description
string	Name of the build configuration.

QueryType

Query type supported by this build configuration.

Declaration

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

Property Value

Type	Description
string	Query type supported by this build configuration.

Readiness

A boolean to indicate allocation readiness status.

Declaration

[DataMember(Name = "readiness", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public bool Readiness { get; set; }

Property Value

Type	Description
bool	A boolean to indicate allocation readiness status.

Speed

CPU utilisation per core.

Declaration

[DataMember(Name = "speed", IsRequired = true, EmitDefaultValue = true)]
[Obsolete]
[Preserve]
public long Speed { get; set; }

Property Value

Type	Description
long	CPU utilisation per core.

UpdatedAt

Date of last update.

Declaration

[DataMember(Name = "updatedAt", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public DateTime UpdatedAt { get; set; }

Property Value

Type	Description
DateTime	Date of last update.

_Configuration

A list of key/value pairs used to configure the associated build. Replaces configuration tokens from v3.

Declaration

[DataMember(Name = "configuration", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<MultiplayBuildConfigurationConfigPair> _Configuration { get; set; }

Property Value

Type	Description
List<MultiplayBuildConfigurationConfigPair>	A list of key/value pairs used to configure the associated build. Replaces configuration tokens from v3.

_Version

Version of the build configuration

Declaration

[DataMember(Name = "version", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long _Version { get; set; }

Property Value

Type	Description
long	Version of the build configuration