@acceleratxr/core_sdk / ServerInstance
Class: ServerInstance#
Describes a single server instance.
REQUIRES: Server Instance Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ ServerInstance
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new ServerInstance(other?: any): ServerInstance
Overrides EntityBase.constructor
Defined in src/models/ServerInstance.ts:79
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: ServerInstance
Properties#
assignmentId#
• assignmentId: string | undefined = undefined
Defined in src/models/ServerInstance.ts:32
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).
buildVersion#
• buildVersion: string = “”
Defined in src/models/ServerInstance.ts:37
The build version of the server instance.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
initOptions#
• initOptions: Array<string> = []
Defined in src/models/ServerInstance.ts:42
A list of options that the server will initialize itself with when a session is assigned.
lastHeartbeat#
• lastHeartbeat: Date = new Date()
Defined in src/models/ServerInstance.ts:47
The date and time that the server instance last sent a heartbeat.
ownerUid#
• ownerUid: string = “”
Defined in src/models/ServerInstance.ts:52
The uid of the user that created and owns ther server instance.
productUid#
• productUid: string | undefined = undefined
Defined in src/models/ServerInstance.ts:59
The uid of the product that this server is associated with.
REQUIRES: Server Instance Services.
region#
• region: string = “”
Defined in src/models/ServerInstance.ts:64
The name of the region that the server instance is running in.
status#
• status: ServerStatus = ServerStatus.STARTING
Defined in src/models/ServerInstance.ts:69
The current runtime status of the server instance.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
url#
• url: string = “”
Defined in src/models/ServerInstance.ts:79
The URL that clients use to establish a connection to the server.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/ServerInstance.ts:26
Returns: string