Class MultiplayBuildConfigurationCreateRequest

Request to create a build configuration with the provided configuration.

Inheritance

object

MultiplayBuildConfigurationCreateRequest

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

Constructors

MultiplayBuildConfigurationCreateRequest(string, long, string, List<ConfigurationPair>, long, long, string, string, bool, long)

Initializes a new instance of the MultiplayBuildConfigurationCreateRequest class.

Declaration

[Preserve]
public MultiplayBuildConfigurationCreateRequest(string binaryPath = null, long buildID = 0, string commandLine = null, List<ConfigurationPair> configuration = null, long cores = 0, long memory = 0, string name = null, string queryType = null, bool readiness = false, long speed = 0)

Parameters

Type	Name	Description
string	binaryPath	Path to the game binary. (required).
long	buildID	Build to associate with the new build configuration. (required).
string	commandLine	Binary launch parameters. (required).
List<ConfigurationPair>	configuration	List of key/value pairs used to configure this build configuration..
long	cores	The number of CPU cores required per server. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation (required).
long	memory	Maximum memory required per server. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation (required).
string	name	Name to use for the new build configuration. (required).
string	queryType	Query type supported by this build configuration. Specific types are supported for bespoke use cases but the most commonly used are 'sqp', 'a2s' or 'none'; if no query capabilities are used. (required).
bool	readiness	A boolean to indicate allocation readiness status. (required).
long	speed	CPU utilisation per core. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation (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

Build to associate with the new build configuration.

Declaration

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

Property Value

Type	Description
long	Build to associate with the new 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. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

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. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

Memory

Maximum memory required per server. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

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. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

Name

Name to use for the new build configuration.

Declaration

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

Property Value

Type	Description
string	Name to use for the new build configuration.

QueryType

Query type supported by this build configuration. Specific types are supported for bespoke use cases but the most commonly used are 'sqp', 'a2s' or 'none'; if no query capabilities are used.

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. Specific types are supported for bespoke use cases but the most commonly used are 'sqp', 'a2s' or 'none'; if no query capabilities are used.

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. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

Declaration

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

Property Value

Type	Description
long	CPU utilisation per core. Now deprecated, please set this field as 0 and configure this setting at a fleet level, or the change will be automatically converted into a fleet based setting. For more information see the server density documentation

_Configuration

List of key/value pairs used to configure this build configuration.

Declaration

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

Property Value

Type	Description
List<ConfigurationPair>	List of key/value pairs used to configure this build configuration.