AutoScalerPolicy (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.policy.basic.AbstractEntityAdjunct
  - - brooklyn.policy.basic.AbstractPolicy
    - - brooklyn.policy.autoscaling.AutoScalerPolicy

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, EntityAdjunct, Policy
```
public class AutoScalerPolicy
extends AbstractPolicy
```
Policy that is attached to a Resizable entity and dynamically adjusts its size in response to emitted POOL_COLD and POOL_HOT events. Alternatively, the policy can be configured to keep a given metric within a required range.
TThis policy does not itself determine whether the pool is hot or cold, but instead relies on these events being emitted by the monitored entity itself, or by another policy that is attached to it; see, for example, LoadBalancingPolicy.)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AutoScalerPolicy.Builder
- Nested classes/interfaces inherited from class brooklyn.policy.basic.AbstractEntityAdjunct
  AbstractEntityAdjunct.AdjunctTagSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Nested Classes
Modifier and Type	Class and Description
`static class`	`AutoScalerPolicy.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<com.google.common.base.Function<Entity,java.lang.Integer>>`	`CURRENT_SIZE_OPERATOR`
`static BasicNotificationSensor<MaxPoolSizeReachedEvent>`	`DEFAULT_MAX_SIZE_REACHED_SENSOR` A convenience for policies that want to register a `builder.maxSizeReachedSensor(sensor)`.
`static BasicNotificationSensor<java.util.Map>`	`DEFAULT_POOL_COLD_SENSOR`
`static BasicNotificationSensor<java.util.Map>`	`DEFAULT_POOL_HOT_SENSOR`
`static BasicNotificationSensor<java.util.Map>`	`DEFAULT_POOL_OK_SENSOR`
`static ConfigKey<Entity>`	`ENTITY_WITH_METRIC`
`static ConfigKey<java.lang.Integer>`	`MAX_POOL_SIZE`
`static ConfigKey<Duration>`	`MAX_REACHED_NOTIFICATION_DELAY`
`static ConfigKey<BasicNotificationSensor<? super MaxPoolSizeReachedEvent>>`	`MAX_SIZE_REACHED_SENSOR`
`static ConfigKey<AttributeSensor<? extends java.lang.Number>>`	`METRIC`
`static ConfigKey<java.lang.Number>`	`METRIC_LOWER_BOUND`
`static ConfigKey<java.lang.Number>`	`METRIC_UPPER_BOUND`
`static ConfigKey<Duration>`	`MIN_PERIOD_BETWEEN_EXECS`
`static ConfigKey<java.lang.Integer>`	`MIN_POOL_SIZE`
`static ConfigKey<BasicNotificationSensor<? extends java.util.Map>>`	`POOL_COLD_SENSOR`
`static java.lang.String`	`POOL_CURRENT_SIZE_KEY`
`static java.lang.String`	`POOL_CURRENT_WORKRATE_KEY`
`static java.lang.String`	`POOL_HIGH_THRESHOLD_KEY`
`static ConfigKey<BasicNotificationSensor<? extends java.util.Map>>`	`POOL_HOT_SENSOR`
`static java.lang.String`	`POOL_LOW_THRESHOLD_KEY`
`static ConfigKey<BasicNotificationSensor<? extends java.util.Map>>`	`POOL_OK_SENSOR`
`static ConfigKey<java.lang.Integer>`	`RESIZE_DOWN_ITERATION_INCREMENT`
`static ConfigKey<java.lang.Integer>`	`RESIZE_DOWN_ITERATION_MAX`
`static ConfigKey<Duration>`	`RESIZE_DOWN_STABILIZATION_DELAY`
`static ConfigKey<ResizeOperator>`	`RESIZE_OPERATOR`
`static ConfigKey<java.lang.Integer>`	`RESIZE_UP_ITERATION_INCREMENT`
`static ConfigKey<java.lang.Integer>`	`RESIZE_UP_ITERATION_MAX`
`static ConfigKey<Duration>`	`RESIZE_UP_STABILIZATION_DELAY`

Constructor Summary

Constructors
Constructor and Description

AutoScalerPolicy()

AutoScalerPolicy(java.util.Map<java.lang.String,?> props)

Constructors
Constructor and Description
`AutoScalerPolicy()`
`AutoScalerPolicy(java.util.Map<java.lang.String,?> props)`

Method Summary

Methods
Modifier and Type	Method and Description
`static AutoScalerPolicy.Builder`	`builder()`
`int`	`getResizeDownIterationIncrement()`
`int`	`getResizeDownIterationMax()`
`int`	`getResizeUpIterationIncrement()`
`int`	`getResizeUpIterationMax()`
`void`	`init()` Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
`void`	`rebind()` Called by framework on rebind (in new-style instances): after configuring, but before the instance is managed, and before adjuncts are attached to entities, and before a reference to an object is shared.
`void`	`resume()` Resume the policy
`void`	`setEntity(EntityLocal entity)`
`void`	`setMaxPoolSize(int val)`
`void`	`setMetricLowerBound(java.lang.Number val)`
`void`	`setMetricUpperBound(java.lang.Number val)`
`void`	`setMinPeriodBetweenExecs(Duration val)`
`void`	`setMinPeriodBetweenExecs(long val)` Deprecated. since 0.7.0; use `setMinPeriodBetweenExecs(Duration)`
`void`	`setMinPoolSize(int val)`
`void`	`setResizeDownIterationIncrement(java.lang.Integer val)`
`void`	`setResizeDownIterationMax(java.lang.Integer val)`
`void`	`setResizeDownStabilizationDelay(Duration val)`
`void`	`setResizeDownStabilizationDelay(long val)` Deprecated. since 0.7.0; use `setResizeDownStabilizationDelay(Duration)`
`void`	`setResizeUpIterationIncrement(java.lang.Integer val)`
`void`	`setResizeUpIterationMax(java.lang.Integer val)`
`void`	`setResizeUpStabilizationDelay(Duration val)`
`void`	`setResizeUpStabilizationDelay(long val)` Deprecated. since 0.7.0; use `setResizeDownStabilizationDelay(Duration)`
`void`	`suspend()` Suspend the policy
`java.lang.String`	`toString()`

Methods inherited from class brooklyn.policy.basic.AbstractPolicy
destroy, getPolicyType, getRebindSupport, isRunning, isSuspended

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct
config, configure, getAllConfig, getConfig, getConfigMap, getDisplayName, getName, getUniqueTag, isDestroyed, setConfig, setDisplayName, setName, tags

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.policy.Policy
getAllConfig, getConfig, getId, getName, setConfig

Methods inherited from interface brooklyn.policy.EntityAdjunct
getUniqueTag, isDestroyed

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getDisplayName, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

Field Detail

DEFAULT_POOL_HOT_SENSOR

public static BasicNotificationSensor<java.util.Map> DEFAULT_POOL_HOT_SENSOR

DEFAULT_POOL_COLD_SENSOR

public static BasicNotificationSensor<java.util.Map> DEFAULT_POOL_COLD_SENSOR

DEFAULT_POOL_OK_SENSOR

public static BasicNotificationSensor<java.util.Map> DEFAULT_POOL_OK_SENSOR

DEFAULT_MAX_SIZE_REACHED_SENSOR
```
public static BasicNotificationSensor<MaxPoolSizeReachedEvent> DEFAULT_MAX_SIZE_REACHED_SENSOR
```
A convenience for policies that want to register a builder.maxSizeReachedSensor(sensor). Note that this "default" is not set automatically; the default is for no sensor to be used (so no events emitted).

POOL_CURRENT_SIZE_KEY

public static final java.lang.String POOL_CURRENT_SIZE_KEY

See Also:: Constant Field Values

POOL_HIGH_THRESHOLD_KEY

public static final java.lang.String POOL_HIGH_THRESHOLD_KEY

See Also:: Constant Field Values

POOL_LOW_THRESHOLD_KEY

public static final java.lang.String POOL_LOW_THRESHOLD_KEY

See Also:: Constant Field Values

POOL_CURRENT_WORKRATE_KEY

public static final java.lang.String POOL_CURRENT_WORKRATE_KEY

See Also:: Constant Field Values

METRIC

public static final ConfigKey<AttributeSensor<? extends java.lang.Number>> METRIC

ENTITY_WITH_METRIC

public static final ConfigKey<Entity> ENTITY_WITH_METRIC

METRIC_LOWER_BOUND

public static final ConfigKey<java.lang.Number> METRIC_LOWER_BOUND

METRIC_UPPER_BOUND

public static final ConfigKey<java.lang.Number> METRIC_UPPER_BOUND

RESIZE_UP_ITERATION_INCREMENT

public static final ConfigKey<java.lang.Integer> RESIZE_UP_ITERATION_INCREMENT

RESIZE_UP_ITERATION_MAX

public static final ConfigKey<java.lang.Integer> RESIZE_UP_ITERATION_MAX

RESIZE_DOWN_ITERATION_INCREMENT

public static final ConfigKey<java.lang.Integer> RESIZE_DOWN_ITERATION_INCREMENT

RESIZE_DOWN_ITERATION_MAX

public static final ConfigKey<java.lang.Integer> RESIZE_DOWN_ITERATION_MAX

MIN_PERIOD_BETWEEN_EXECS

public static final ConfigKey<Duration> MIN_PERIOD_BETWEEN_EXECS

RESIZE_UP_STABILIZATION_DELAY

public static final ConfigKey<Duration> RESIZE_UP_STABILIZATION_DELAY

RESIZE_DOWN_STABILIZATION_DELAY

public static final ConfigKey<Duration> RESIZE_DOWN_STABILIZATION_DELAY

MIN_POOL_SIZE

public static final ConfigKey<java.lang.Integer> MIN_POOL_SIZE

MAX_POOL_SIZE

public static final ConfigKey<java.lang.Integer> MAX_POOL_SIZE

RESIZE_OPERATOR

public static final ConfigKey<ResizeOperator> RESIZE_OPERATOR

CURRENT_SIZE_OPERATOR

public static final ConfigKey<com.google.common.base.Function<Entity,java.lang.Integer>> CURRENT_SIZE_OPERATOR

POOL_HOT_SENSOR

public static final ConfigKey<BasicNotificationSensor<? extends java.util.Map>> POOL_HOT_SENSOR

POOL_COLD_SENSOR

public static final ConfigKey<BasicNotificationSensor<? extends java.util.Map>> POOL_COLD_SENSOR

POOL_OK_SENSOR

public static final ConfigKey<BasicNotificationSensor<? extends java.util.Map>> POOL_OK_SENSOR

MAX_SIZE_REACHED_SENSOR

public static final ConfigKey<BasicNotificationSensor<? super MaxPoolSizeReachedEvent>> MAX_SIZE_REACHED_SENSOR

MAX_REACHED_NOTIFICATION_DELAY

public static final ConfigKey<Duration> MAX_REACHED_NOTIFICATION_DELAY

Constructor Detail

AutoScalerPolicy
```
public AutoScalerPolicy()
```

AutoScalerPolicy

public AutoScalerPolicy(java.util.Map<java.lang.String,?> props)

Method Detail
- builder
```
public static AutoScalerPolicy.Builder builder()
```
- init
```
public void init()
```
  Description copied from class: AbstractBrooklynObject
  Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
  To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.
```
 if (isLegacyConstruction()) {
     init();
 }
 
 
```
  Overrides:
  
  init in class AbstractBrooklynObject
- rebind
```
public void rebind()
```
  Description copied from class: AbstractBrooklynObject
  Called by framework on rebind (in new-style instances):
  - after configuring, but
  - before the instance is managed, and
  - before adjuncts are attached to entities, and
  - before a reference to an object is shared.
  Note that AbstractBrooklynObject.init() will not be called on rebind.
  If you need to intercept behaviour after adjuncts are attached, consider AbstractEntity.onManagementStarting() (but probably worth raising a discussion on the mailing list!)
  Overrides:
  
  rebind in class AbstractBrooklynObject
- setMetricLowerBound
```
public void setMetricLowerBound(java.lang.Number val)
```
- setMetricUpperBound
```
public void setMetricUpperBound(java.lang.Number val)
```
- getResizeUpIterationIncrement
```
public int getResizeUpIterationIncrement()
```
- setResizeUpIterationIncrement
```
public void setResizeUpIterationIncrement(java.lang.Integer val)
```
- getResizeDownIterationIncrement
```
public int getResizeDownIterationIncrement()
```
- setResizeDownIterationIncrement
```
public void setResizeDownIterationIncrement(java.lang.Integer val)
```
- getResizeUpIterationMax
```
public int getResizeUpIterationMax()
```
- setResizeUpIterationMax
```
public void setResizeUpIterationMax(java.lang.Integer val)
```
- getResizeDownIterationMax
```
public int getResizeDownIterationMax()
```
- setResizeDownIterationMax
```
public void setResizeDownIterationMax(java.lang.Integer val)
```
- setMinPeriodBetweenExecs
```
public void setMinPeriodBetweenExecs(long val)
```
  Deprecated. since 0.7.0; use setMinPeriodBetweenExecs(Duration)
- setMinPeriodBetweenExecs
```
public void setMinPeriodBetweenExecs(Duration val)
```
- setResizeUpStabilizationDelay
```
public void setResizeUpStabilizationDelay(long val)
```
  Deprecated. since 0.7.0; use setResizeDownStabilizationDelay(Duration)
- setResizeUpStabilizationDelay
```
public void setResizeUpStabilizationDelay(Duration val)
```
- setResizeDownStabilizationDelay
```
public void setResizeDownStabilizationDelay(long val)
```
  Deprecated. since 0.7.0; use setResizeDownStabilizationDelay(Duration)
- setResizeDownStabilizationDelay
```
public void setResizeDownStabilizationDelay(Duration val)
```
- setMinPoolSize
```
public void setMinPoolSize(int val)
```
- setMaxPoolSize
```
public void setMaxPoolSize(int val)
```
- suspend
```
public void suspend()
```
  Description copied from interface: Policy
  
  Suspend the policy
  
  Specified by:
  
  suspend in interface Policy
  
  Overrides:
  
  suspend in class AbstractPolicy
- resume
```
public void resume()
```
  Description copied from interface: Policy
  
  Resume the policy
  
  Specified by:
  
  resume in interface Policy
  
  Overrides:
  
  resume in class AbstractPolicy
- setEntity
```
public void setEntity(EntityLocal entity)
```
  Overrides:
  
  setEntity in class AbstractEntityAdjunct
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class AbstractPolicy

Class AutoScalerPolicy

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.policy.basic.AbstractPolicy

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.policy.Policy

Methods inherited from interface brooklyn.policy.EntityAdjunct

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Detail

DEFAULT_POOL_HOT_SENSOR

DEFAULT_POOL_COLD_SENSOR

DEFAULT_POOL_OK_SENSOR

DEFAULT_MAX_SIZE_REACHED_SENSOR

POOL_CURRENT_SIZE_KEY

POOL_HIGH_THRESHOLD_KEY

POOL_LOW_THRESHOLD_KEY

POOL_CURRENT_WORKRATE_KEY

METRIC

ENTITY_WITH_METRIC

METRIC_LOWER_BOUND

METRIC_UPPER_BOUND

RESIZE_UP_ITERATION_INCREMENT

RESIZE_UP_ITERATION_MAX

RESIZE_DOWN_ITERATION_INCREMENT

RESIZE_DOWN_ITERATION_MAX

MIN_PERIOD_BETWEEN_EXECS

RESIZE_UP_STABILIZATION_DELAY

RESIZE_DOWN_STABILIZATION_DELAY

MIN_POOL_SIZE

MAX_POOL_SIZE

RESIZE_OPERATOR

CURRENT_SIZE_OPERATOR

POOL_HOT_SENSOR

POOL_COLD_SENSOR

POOL_OK_SENSOR

MAX_SIZE_REACHED_SENSOR

MAX_REACHED_NOTIFICATION_DELAY

Constructor Detail

AutoScalerPolicy

AutoScalerPolicy

Method Detail

builder

init

rebind

setMetricLowerBound

setMetricUpperBound

getResizeUpIterationIncrement

setResizeUpIterationIncrement

getResizeDownIterationIncrement

setResizeDownIterationIncrement

getResizeUpIterationMax

setResizeUpIterationMax

getResizeDownIterationMax

setResizeDownIterationMax

setMinPeriodBetweenExecs

setMinPeriodBetweenExecs

setResizeUpStabilizationDelay

setResizeUpStabilizationDelay

setResizeDownStabilizationDelay

setResizeDownStabilizationDelay

setMinPoolSize

setMaxPoolSize

suspend

resume

setEntity

toString