@acceleratxr/core_sdk / ScalingPolicy
Class: ScalingPolicy#
Defines a single policy that determines how one or more zones will scale the number of available shards.
REQUIRES: Virtual World Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ ScalingPolicy
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new ScalingPolicy(other?: any): ScalingPolicy
Overrides EntityBase.constructor
Defined in src/models/ScalingPolicy.ts:72
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: ScalingPolicy
Properties#
action#
• action: Action = Action.ADD
Defined in src/models/ScalingPolicy.ts:42
Indicates the scaling action that will be performed. Default is ADD.
amount#
• amount: number = 1
Defined in src/models/ScalingPolicy.ts:47
The amount of resources that will be applied when the scaling action occurs.
appliesTo#
• appliesTo: AppliesTo = AppliesTo.ZONE
Defined in src/models/ScalingPolicy.ts:52
Indicates the scaling action that will be performed. Default is ZONE.
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.
interval#
• interval: string = “1m”
Defined in src/models/ScalingPolicy.ts:57
The amount of time to wait, in seconds, before this scaling policy will take effect again.
maxPopulation#
• maxPopulation: number = 1
Defined in src/models/ScalingPolicy.ts:62
The maximum percentage of the total shard population that triggers this policy.
minPopulation#
• minPopulation: number = 0.5
Defined in src/models/ScalingPolicy.ts:67
The minimum percentage of the total shard population that triggers this policy.
name#
• name: string = “”
Defined in src/models/ScalingPolicy.ts:37
The unique name of the object.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
zones#
• zones: Array<string> = []
Defined in src/models/ScalingPolicy.ts:72
The list of zone uid’s that the scaling rule applies to. If empty then applies to all zones.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/ScalingPolicy.ts:32
Returns: string