Class ScalingPolicy

• Defined in File ScalingPolicy.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.ScalingPolicy : xbe.sdk.EntityBase

Defines a single policy that determines how one or more zones will scale the number of available shards.

REQUIRES: Virtual World Services

Public Functions

ScalingPolicy ()

ScalingPolicy (Object obj)

Properties

Action Action { get; set; }

Indicates the scaling action that will be performed. Default is ADD.

double Amount { get; set; }

The amount of resources that will be applied when the scaling action occurs.

AppliesTo AppliesTo { get; set; }

Indicates the scaling action that will be performed. Default is ZONE.

string Interval { get; set; }

The amount of time to wait, in seconds, before this scaling policy will take effect again.

double MaxPopulation { get; set; }

The maximum percentage of the total shard population that triggers this policy.

double MinPopulation { get; set; }

The minimum percentage of the total shard population that triggers this policy.

string > Zones { get; set; }

The list of zone uid’s that the scaling rule applies to. If empty then applies to all zones.

Public Static Functions

new ScalingPolicy Parse (string json)

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

Param json:

Return:

Public Static Attributes

const string ONE_M = "1m"

Default interval.

const double MAX_POPULATION = 1.0f

Default Max Population.

const double MIN_POPULATION = 0.5f

Default Min Population.