docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class MultiplayMachinesMachine

    A single machine.

    Inheritance
    object
    MultiplayMachinesMachine
    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.machines.machine")]
    [Preserve]
    public class MultiplayMachinesMachine

    Constructors

    MultiplayMachinesMachine(bool, long, bool, string, string, MultiplayMachinesHardwareType, long, string, long, string, string, OsFamilyEnum, string, MultiplayMachinesServersStates, MultiplayMachinesSpec, MultiplayMachinesStatus)

    Initializes a new instance of the MultiplayMachinesMachine class.

    Declaration
    [Preserve]
    public MultiplayMachinesMachine(bool deleted = false, long desiredServerCount = 0, bool disabled = false, string fleetId = null, string fleetName = null, MultiplayMachinesHardwareType hardwareType = (MultiplayMachinesHardwareType)0, long id = 0, string ip = null, long locationId = 0, string locationName = null, string name = null, MultiplayMachinesMachine.OsFamilyEnum osFamily = (MultiplayMachinesMachine.OsFamilyEnum)0, string osName = null, MultiplayMachinesServersStates serversStates = null, MultiplayMachinesSpec spec = null, MultiplayMachinesStatus status = (MultiplayMachinesStatus)0)
    Parameters
    Type Name Description
    bool deleted

    Whether the machine is marked as deleted. (required).

    long desiredServerCount

    Indicate the expected number of servers after rescaling.

    bool disabled

    Whether the machine is marked as disabled. (required).

    string fleetId

    ID of the associated fleet. (required).

    string fleetName

    Name of the associated fleet. (required).

    MultiplayMachinesHardwareType hardwareType

    hardwareType (required).

    long id

    ID of the machine. (required).

    string ip

    IP address of the machine. (required).

    long locationId

    ID of the associated location. (required).

    string locationName

    Name of the associated location. (required).

    string name

    Name of the machine. (required).

    MultiplayMachinesMachine.OsFamilyEnum osFamily

    osFamily (required).

    string osName

    Full name of the Operating System machine is running on. (required).

    MultiplayMachinesServersStates serversStates

    serversStates (required).

    MultiplayMachinesSpec spec

    spec (required).

    MultiplayMachinesStatus status

    status (required).

    Properties

    Deleted

    Whether the machine 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 machine is marked as deleted.

    DesiredServerCount

    Indicate the expected number of servers after rescaling

    Declaration
    [DataMember(Name = "desiredServerCount", EmitDefaultValue = false)]
    [Preserve]
    public long DesiredServerCount { get; set; }
    Property Value
    Type Description
    long

    Indicate the expected number of servers after rescaling

    Disabled

    Whether the machine is marked as disabled.

    Declaration
    [DataMember(Name = "disabled", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public bool Disabled { get; set; }
    Property Value
    Type Description
    bool

    Whether the machine is marked as disabled.

    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 MultiplayMachinesHardwareType HardwareType { get; set; }
    Property Value
    Type Description
    MultiplayMachinesHardwareType

    Id

    ID of the machine.

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

    ID of the machine.

    Ip

    IP address of the machine.

    Declaration
    [DataMember(Name = "ip", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public string Ip { get; set; }
    Property Value
    Type Description
    string

    IP address of the machine.

    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.

    Name

    Name of the machine.

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

    Name of the machine.

    OsFamily

    Gets or Sets OsFamily

    Declaration
    [DataMember(Name = "osFamily", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public MultiplayMachinesMachine.OsFamilyEnum OsFamily { get; set; }
    Property Value
    Type Description
    MultiplayMachinesMachine.OsFamilyEnum

    OsName

    Full name of the Operating System machine is running on.

    Declaration
    [DataMember(Name = "osName", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public string OsName { get; set; }
    Property Value
    Type Description
    string

    Full name of the Operating System machine is running on.

    ServersStates

    Gets or Sets ServersStates

    Declaration
    [DataMember(Name = "serversStates", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public MultiplayMachinesServersStates ServersStates { get; set; }
    Property Value
    Type Description
    MultiplayMachinesServersStates

    Spec

    Gets or Sets Spec

    Declaration
    [DataMember(Name = "spec", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public MultiplayMachinesSpec Spec { get; set; }
    Property Value
    Type Description
    MultiplayMachinesSpec

    Status

    Gets or Sets Status

    Declaration
    [DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
    [Preserve]
    public MultiplayMachinesStatus Status { get; set; }
    Property Value
    Type Description
    MultiplayMachinesStatus
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)