Class MultiplayServersServer1
A single server.
Inherited Members
Namespace: Unity.Services.Apis.Admin.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "multiplay.servers.server1")]
[Preserve]
public class MultiplayServersServer1
Constructors
MultiplayServersServer1(long, string, string, long, bool, string, string, MultiplayServersHardwareType, long, long, string, long, string, long, string, MultiplayServersMachineSpec, long, int, MultiplayServersServerStatus)
Initializes a new instance of the Multiplay
Declaration
[Preserve]
public MultiplayServersServer1(long buildConfigurationID = 0, string buildConfigurationName = null, string buildName = null, long cpuLimit = 0, bool deleted = false, string fleetID = null, string fleetName = null, MultiplayServersHardwareType hardwareType = (MultiplayServersHardwareType)0, long holdExpiresAt = 0, long id = 0, string ip = null, long locationID = 0, string locationName = null, long machineID = 0, string machineName = null, MultiplayServersMachineSpec machineSpec = null, long memoryLimit = 0, int port = 0, MultiplayServersServerStatus status = (MultiplayServersServerStatus)0)
Parameters
Type | Name | Description |
---|---|---|
long | buildConfigurationID | ID of the associated build configuration. (required). |
string | buildConfigurationName | Name of the associated build configuration. (required). |
string | buildName | Name of the build for the associated build configuration. (required). |
long | cpuLimit | CPU Speed Limit (MHz) of the server. (required). |
bool | deleted | Whether the server is marked as deleted. (required). |
string | fleetID | ID of the associated fleet. (required). |
string | fleetName | Name of the associated fleet. (required). |
Multiplay |
hardwareType | hardwareType (required). |
long | holdExpiresAt | The unix timestamp, in seconds, at which a held server automatically expires and releases its hold.. |
long | id | ID of the server. (required). |
string | ip | IP address of the server. (required). |
long | locationID | ID of the associated location. (required). |
string | locationName | Name of the associated location. (required). |
long | machineID | ID of the machine hosting the server. (required). |
string | machineName | Name of the machine hosting the server. (required). |
Multiplay |
machineSpec | machineSpec (required). |
long | memoryLimit | Memory (RAM) (MiB) Limit of the server. (required). |
int | port | Network port the server is running on. (required). |
Multiplay |
status | status (required). |
Properties
BuildConfigurationID
ID of the associated build configuration.
Declaration
[DataMember(Name = "buildConfigurationID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long BuildConfigurationID { get; set; }
Property Value
Type | Description |
---|---|
long | ID of the associated build configuration. |
BuildConfigurationName
Name of the associated build configuration.
Declaration
[DataMember(Name = "buildConfigurationName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string BuildConfigurationName { get; set; }
Property Value
Type | Description |
---|---|
string | Name of the associated build configuration. |
BuildName
Name of the build for the associated 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 for the associated build configuration. |
CpuLimit
CPU Speed Limit (MHz) of the server.
Declaration
[DataMember(Name = "cpuLimit", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long CpuLimit { get; set; }
Property Value
Type | Description |
---|---|
long | CPU Speed Limit (MHz) of the server. |
Deleted
Whether the server is marked as deleted.
Declaration
[DataMember(Name = "deleted", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public bool Deleted { get; set; }
Property Value
Type | Description |
---|---|
bool | Whether the server is marked as deleted. |
FleetID
ID of the associated fleet.
Declaration
[DataMember(Name = "fleetID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string FleetID { get; set; }
Property Value
Type | Description |
---|---|
string | ID of the associated fleet. |
FleetName
Name of the associated fleet.
Declaration
[DataMember(Name = "fleetName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string FleetName { get; set; }
Property Value
Type | Description |
---|---|
string | Name of the associated fleet. |
HardwareType
Gets or Sets HardwareType
Declaration
[DataMember(Name = "hardwareType", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayServersHardwareType HardwareType { get; set; }
Property Value
Type | Description |
---|---|
Multiplay |
HoldExpiresAt
The unix timestamp, in seconds, at which a held server automatically expires and releases its hold.
Declaration
[DataMember(Name = "holdExpiresAt", EmitDefaultValue = false)]
[Preserve]
public long HoldExpiresAt { get; set; }
Property Value
Type | Description |
---|---|
long | The unix timestamp, in seconds, at which a held server automatically expires and releases its hold. |
Id
ID of the server.
Declaration
[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long Id { get; set; }
Property Value
Type | Description |
---|---|
long | ID of the server. |
Ip
IP address of the server.
Declaration
[DataMember(Name = "ip", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Ip { get; set; }
Property Value
Type | Description |
---|---|
string | IP address of the server. |
LocationID
ID of the associated location.
Declaration
[DataMember(Name = "locationID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long LocationID { get; set; }
Property Value
Type | Description |
---|---|
long | ID of the associated location. |
LocationName
Name of the associated location.
Declaration
[DataMember(Name = "locationName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string LocationName { get; set; }
Property Value
Type | Description |
---|---|
string | Name of the associated location. |
MachineID
ID of the machine hosting the server.
Declaration
[DataMember(Name = "machineID", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long MachineID { get; set; }
Property Value
Type | Description |
---|---|
long | ID of the machine hosting the server. |
MachineName
Name of the machine hosting the server.
Declaration
[DataMember(Name = "machineName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string MachineName { get; set; }
Property Value
Type | Description |
---|---|
string | Name of the machine hosting the server. |
MachineSpec
Gets or Sets MachineSpec
Declaration
[DataMember(Name = "machineSpec", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayServersMachineSpec MachineSpec { get; set; }
Property Value
Type | Description |
---|---|
Multiplay |
MemoryLimit
Memory (RAM) (MiB) Limit of the server.
Declaration
[DataMember(Name = "memoryLimit", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long MemoryLimit { get; set; }
Property Value
Type | Description |
---|---|
long | Memory (RAM) (MiB) Limit of the server. |
Port
Network port the server is running on.
Declaration
[DataMember(Name = "port", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int Port { get; set; }
Property Value
Type | Description |
---|---|
int | Network port the server is running on. |
Status
Gets or Sets Status
Declaration
[DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public MultiplayServersServerStatus Status { get; set; }
Property Value
Type | Description |
---|---|
Multiplay |