public class ScalingPolicy
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
comparisonOperator
Comparison operator to use when measuring a metric against the threshold
value.
|
private java.lang.Integer |
evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold
before a scaling event is triggered.
|
private java.lang.String |
fleetId
Unique identity for the fleet associated with this scaling policy.
|
private java.lang.String |
metricName
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
private java.lang.String |
name
Descriptive label associated with this scaling policy.
|
private java.lang.Integer |
scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
|
private java.lang.String |
scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
private java.lang.String |
status
Current status of the scaling policy.
|
private java.lang.Double |
threshold
Metric value used to trigger a scaling event.
|
Constructor and Description |
---|
ScalingPolicy() |
Modifier and Type | Method and Description |
---|---|
ScalingPolicy |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getComparisonOperator()
Comparison operator to use when measuring a metric against the threshold
value.
|
java.lang.Integer |
getEvaluationPeriods()
Length of time (in minutes) the metric must be at or beyond the threshold
before a scaling event is triggered.
|
java.lang.String |
getFleetId()
Unique identity for the fleet associated with this scaling policy.
|
java.lang.String |
getMetricName()
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
java.lang.String |
getName()
Descriptive label associated with this scaling policy.
|
java.lang.Integer |
getScalingAdjustment()
Amount of adjustment to make, based on the scaling adjustment type.
|
java.lang.String |
getScalingAdjustmentType()
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
java.lang.String |
getStatus()
Current status of the scaling policy.
|
java.lang.Double |
getThreshold()
Metric value used to trigger a scaling event.
|
int |
hashCode() |
void |
setComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold
value.
|
void |
setComparisonOperator(java.lang.String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold
value.
|
void |
setEvaluationPeriods(java.lang.Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold
before a scaling event is triggered.
|
void |
setFleetId(java.lang.String fleetId)
Unique identity for the fleet associated with this scaling policy.
|
void |
setMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
void |
setMetricName(java.lang.String metricName)
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
void |
setName(java.lang.String name)
Descriptive label associated with this scaling policy.
|
void |
setScalingAdjustment(java.lang.Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
|
void |
setScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
void |
setScalingAdjustmentType(java.lang.String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
void |
setStatus(ScalingStatusType status)
Current status of the scaling policy.
|
void |
setStatus(java.lang.String status)
Current status of the scaling policy.
|
void |
setThreshold(java.lang.Double threshold)
Metric value used to trigger a scaling event.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ScalingPolicy |
withComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold
value.
|
ScalingPolicy |
withComparisonOperator(java.lang.String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold
value.
|
ScalingPolicy |
withEvaluationPeriods(java.lang.Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold
before a scaling event is triggered.
|
ScalingPolicy |
withFleetId(java.lang.String fleetId)
Unique identity for the fleet associated with this scaling policy.
|
ScalingPolicy |
withMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
ScalingPolicy |
withMetricName(java.lang.String metricName)
Name of the GameLift-defined metric that is used to trigger an
adjustment.
|
ScalingPolicy |
withName(java.lang.String name)
Descriptive label associated with this scaling policy.
|
ScalingPolicy |
withScalingAdjustment(java.lang.Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
|
ScalingPolicy |
withScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
ScalingPolicy |
withScalingAdjustmentType(java.lang.String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ChangeInCapacity: add (or subtract) the scaling adjustment value from
the current instance count.
|
ScalingPolicy |
withStatus(ScalingStatusType status)
Current status of the scaling policy.
|
ScalingPolicy |
withStatus(java.lang.String status)
Current status of the scaling policy.
|
ScalingPolicy |
withThreshold(java.lang.Double threshold)
Metric value used to trigger a scaling event.
|
private java.lang.String fleetId
Unique identity for the fleet associated with this scaling policy.
private java.lang.String name
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
private java.lang.String status
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
private java.lang.Integer scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
private java.lang.String scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
private java.lang.String comparisonOperator
Comparison operator to use when measuring a metric against the threshold value.
private java.lang.Double threshold
Metric value used to trigger a scaling event.
private java.lang.Integer evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
private java.lang.String metricName
Name of the GameLift-defined metric that is used to trigger an adjustment.
public void setFleetId(java.lang.String fleetId)
Unique identity for the fleet associated with this scaling policy.
fleetId
- Unique identity for the fleet associated with this scaling policy.public java.lang.String getFleetId()
Unique identity for the fleet associated with this scaling policy.
public ScalingPolicy withFleetId(java.lang.String fleetId)
Unique identity for the fleet associated with this scaling policy.
fleetId
- Unique identity for the fleet associated with this scaling policy.public void setName(java.lang.String name)
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
name
- Descriptive label associated with this scaling policy. Policy
names do not need to be unique.public java.lang.String getName()
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
public ScalingPolicy withName(java.lang.String name)
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
name
- Descriptive label associated with this scaling policy. Policy
names do not need to be unique.public void setStatus(java.lang.String status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
status
- Current status of the scaling policy. The scaling policy is only
in force when in an Active state.
ScalingStatusType
public java.lang.String getStatus()
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
ScalingStatusType
public ScalingPolicy withStatus(java.lang.String status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
status
- Current status of the scaling policy. The scaling policy is only
in force when in an Active state.
ScalingStatusType
public void setStatus(ScalingStatusType status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
status
- Current status of the scaling policy. The scaling policy is only
in force when in an Active state.
ScalingStatusType
public ScalingPolicy withStatus(ScalingStatusType status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
status
- Current status of the scaling policy. The scaling policy is only
in force when in an Active state.
ScalingStatusType
public void setScalingAdjustment(java.lang.Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
scalingAdjustment
- Amount of adjustment to make, based on the scaling adjustment
type.public java.lang.Integer getScalingAdjustment()
Amount of adjustment to make, based on the scaling adjustment type.
public ScalingPolicy withScalingAdjustment(java.lang.Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
scalingAdjustment
- Amount of adjustment to make, based on the scaling adjustment
type.public void setScalingAdjustmentType(java.lang.String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
scalingAdjustmentType
- Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ScalingAdjustmentType
public java.lang.String getScalingAdjustmentType()
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
ScalingAdjustmentType
public ScalingPolicy withScalingAdjustmentType(java.lang.String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
scalingAdjustmentType
- Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ScalingAdjustmentType
public void setScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
scalingAdjustmentType
- Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ScalingAdjustmentType
public ScalingPolicy withScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
scalingAdjustmentType
- Type of adjustment to make to a fleet's instance count (see
FleetCapacity):
ScalingAdjustmentType
public void setComparisonOperator(java.lang.String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the
threshold value.ComparisonOperatorType
public java.lang.String getComparisonOperator()
Comparison operator to use when measuring a metric against the threshold value.
ComparisonOperatorType
public ScalingPolicy withComparisonOperator(java.lang.String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the
threshold value.ComparisonOperatorType
public void setComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the
threshold value.ComparisonOperatorType
public ScalingPolicy withComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the
threshold value.ComparisonOperatorType
public void setThreshold(java.lang.Double threshold)
Metric value used to trigger a scaling event.
threshold
- Metric value used to trigger a scaling event.public java.lang.Double getThreshold()
Metric value used to trigger a scaling event.
public ScalingPolicy withThreshold(java.lang.Double threshold)
Metric value used to trigger a scaling event.
threshold
- Metric value used to trigger a scaling event.public void setEvaluationPeriods(java.lang.Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
evaluationPeriods
- Length of time (in minutes) the metric must be at or beyond the
threshold before a scaling event is triggered.public java.lang.Integer getEvaluationPeriods()
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
public ScalingPolicy withEvaluationPeriods(java.lang.Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
evaluationPeriods
- Length of time (in minutes) the metric must be at or beyond the
threshold before a scaling event is triggered.public void setMetricName(java.lang.String metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.
metricName
- Name of the GameLift-defined metric that is used to trigger an
adjustment.
MetricName
public java.lang.String getMetricName()
Name of the GameLift-defined metric that is used to trigger an adjustment.
MetricName
public ScalingPolicy withMetricName(java.lang.String metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.
metricName
- Name of the GameLift-defined metric that is used to trigger an
adjustment.
MetricName
public void setMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.
metricName
- Name of the GameLift-defined metric that is used to trigger an
adjustment.
MetricName
public ScalingPolicy withMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.
metricName
- Name of the GameLift-defined metric that is used to trigger an
adjustment.
MetricName
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ScalingPolicy clone()
clone
in class java.lang.Object