Class ServerInfo

Information regarding the server

Inheritance

object

ServerInfo

Implements

IEquatable<ServerInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Multiplay.Authoring.Core.MultiplayApi

Assembly: Unity.Services.Multiplayer.Multiplay.Authoring.Core.dll

Syntax

public record ServerInfo : IEquatable<ServerInfo>

Constructors

ServerInfo(long, long, string, long, string, string, Guid, string, long, string, string, int, ServerStatus, long, long, bool, long)

Information regarding the server

Declaration

public ServerInfo(long Id, long MachineID, string MachineName, long BuildConfigurationID, string BuildConfigurationName, string BuildName, Guid FleetID, string FleetName, long LocationID, string LocationName, string Ip, int Port, ServerStatus Status, long CpuLimit, long MemoryLimit, bool Deleted, long HoldExpiresAt = 0)

Parameters

Type	Name	Description
long	Id	ID of the server.
long	MachineID	ID of the machine hosting the server.
string	MachineName	Name of the machine hosting the server.
long	BuildConfigurationID	ID of the associated build configuration.
string	BuildConfigurationName	Name of the associated build configuration.
string	BuildName	Name of the build for the associated build configuration.
Guid	FleetID	ID of the associated fleet.
string	FleetName	Name of the associated fleet.
long	LocationID	ID of the associated location.
string	LocationName	Name of the associated location.
string	Ip	IP address of the server.
int	Port	Network port the server is running on.
ServerStatus	Status	Status of the server.
long	CpuLimit	CPU Speed Limit (MHz) of the server.
long	MemoryLimit	Memory (RAM) (MiB) Limit of the server.
bool	Deleted	Whether the server is marked as deleted.
long	HoldExpiresAt	The unix timestamp, in seconds, at which a held server automatically expires and releases its hold.

Properties

BuildConfigurationID

ID of the associated build configuration.

Declaration

public long BuildConfigurationID { get; init; }

Property Value

Type	Description
long

BuildConfigurationName

Name of the associated build configuration.

Declaration

public string BuildConfigurationName { get; init; }

Property Value

Type	Description
string

BuildName

Name of the build for the associated build configuration.

Declaration

public string BuildName { get; init; }

Property Value

Type	Description
string

CpuLimit

CPU Speed Limit (MHz) of the server.

Declaration

public long CpuLimit { get; init; }

Property Value

Type	Description
long

Deleted

Whether the server is marked as deleted.

Declaration

public bool Deleted { get; init; }

Property Value

Type	Description
bool

FleetID

ID of the associated fleet.

Declaration

public Guid FleetID { get; init; }

Property Value

Type	Description
Guid

FleetName

Name of the associated fleet.

Declaration

public string FleetName { get; init; }

Property Value

Type	Description
string

HoldExpiresAt

The unix timestamp, in seconds, at which a held server automatically expires and releases its hold.

Declaration

public long HoldExpiresAt { get; init; }

Property Value

Type	Description
long

Id

ID of the server.

Declaration

public long Id { get; init; }

Property Value

Type	Description
long

Ip

IP address of the server.

Declaration

public string Ip { get; init; }

Property Value

Type	Description
string

LocationID

ID of the associated location.

Declaration

public long LocationID { get; init; }

Property Value

Type	Description
long

LocationName

Name of the associated location.

Declaration

public string LocationName { get; init; }

Property Value

Type	Description
string

MachineID

ID of the machine hosting the server.

Declaration

public long MachineID { get; init; }

Property Value

Type	Description
long

MachineName

Name of the machine hosting the server.

Declaration

public string MachineName { get; init; }

Property Value

Type	Description
string

MemoryLimit

Memory (RAM) (MiB) Limit of the server.

Declaration

public long MemoryLimit { get; init; }

Property Value

Type	Description
long

Port

Network port the server is running on.

Declaration

public int Port { get; init; }

Property Value

Type	Description
int

Status

Status of the server.

Declaration

public ServerStatus Status { get; init; }

Property Value

Type	Description
ServerStatus

Implements

IEquatable<T>