Class ServerInstance

• Defined in File ServerInstance.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.ServerInstance : xbe.sdk.EntityBase

Describes a single dedicated server instance.

REQUIRES: Server Instance Services

Public Functions

ServerInstance ()

ServerInstance (Object obj)

Properties

string AssignmentId { get; set; }

The type and uid of the server’s assignment (e.g. Shard or Session). The value takes the format [session|shard]:<uid> (e.g. session:570d4dbe-4d57-4f80-aa74-4948248772a0).

string BuildVersion { get; set; }

The build version of the server instance.

string > InitOptions { get; set; }

A list of options that the server will initialize itself with when a session is assigned.

DateTime LastHeartbeat { get; set; }

The date and time that the server instance last sent a heartbeat.

Guid OwnerUid { get; set; }

The uid of the user that created and owns the server instance.

Guid ProductUid { get; set; }

The uid of the product that this server is associated with.

REQUIRES: Server Instance Services Studio.

string Region { get; set; }

The name of the region that the server instance is running in.

string Status { get; set; }

The current runtime status of the server instance.

string > Tags { get; set; }

A list of descriptive labels associated with the server.

string Url { get; set; }

The URL that clients use to establish a connection to the server.

Public Static Functions

new ServerInstance Parse (string json)

Parses the given JSON encoded string into a new ServerInstance instance.

Param json:

Return:

Public Static Attributes

const string STATUS_INVALID = "INVALID"

const string STATUS_STARTING = "STARTING"

const string STATUS_AWAITING_CONNECTIONS = "AWAITING_CONNECTIONS"

const string STATUS_IN_PROGRESS = "IN_PROGRESS"

const string STATUS_STOPPED = "STOPPED"

const string STATUS_COMPLETED = "COMPLETED"

const string STATUS_ABORTED = "ABORTED"