Class Scale
- java.lang.Object
-
- com.softlayer.api.Type
-
- com.softlayer.api.service.Entity
-
- com.softlayer.api.service.scale.policy.Action
-
- com.softlayer.api.service.scale.policy.action.Scale
-
@ApiType("SoftLayer_Scale_Policy_Action_Scale") public class Scale extends Action
A policy action to scale a group. A group can be scaled to an absolute member number or by a relative amount using a fixed number or a percentage.- See Also:
- SoftLayer_Scale_Policy_Action_Scale
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Scale.Mask
static interface
Scale.Service
A policy action to scale a group.static interface
Scale.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Long
amount
The number to scale by.protected boolean
amountSpecified
protected String
scaleType
The type of scale to perform.protected boolean
scaleTypeSpecified
-
Fields inherited from class com.softlayer.api.service.scale.policy.Action
createDate, createDateSpecified, deleteFlag, deleteFlagSpecified, id, idSpecified, modifyDate, modifyDateSpecified, scalePolicy, scalePolicyId, scalePolicyIdSpecified, type, typeId, typeIdSpecified
-
Fields inherited from class com.softlayer.api.Type
unknownProperties
-
-
Constructor Summary
Constructors Constructor Description Scale()
-
Method Summary
Modifier and Type Method Description Scale.Service
asService(ApiClient client)
Long
getAmount()
String
getScaleType()
boolean
isAmountSpecified()
boolean
isScaleTypeSpecified()
static Scale.Service
service(ApiClient client)
static Scale.Service
service(ApiClient client, Long id)
void
setAmount(Long amount)
void
setScaleType(String scaleType)
void
unsetAmount()
void
unsetScaleType()
-
Methods inherited from class com.softlayer.api.service.scale.policy.Action
getCreateDate, getDeleteFlag, getId, getModifyDate, getScalePolicy, getScalePolicyId, getType, getTypeId, isCreateDateSpecified, isDeleteFlagSpecified, isIdSpecified, isModifyDateSpecified, isScalePolicyIdSpecified, isTypeIdSpecified, setCreateDate, setDeleteFlag, setId, setModifyDate, setScalePolicy, setScalePolicyId, setType, setTypeId, unsetCreateDate, unsetDeleteFlag, unsetId, unsetModifyDate, unsetScalePolicyId, unsetTypeId
-
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
-
-
-
Field Detail
-
amount
@ApiProperty(canBeNullOrNotSet=true) protected Long amount
The number to scale by. This number has different meanings based on type.
-
amountSpecified
protected boolean amountSpecified
-
scaleType
@ApiProperty(canBeNullOrNotSet=true) protected String scaleType
The type of scale to perform. Possible values:
* ABSOLUTE - Force the group to be set at a specific number of group members. This may include scaling up or
down or not at all. If the amount is outside of the min/max range of the group, an error occurs.
* PERCENT - Scale the group up or down based on the positive or negative percentage given in amount. The
number is a percent of the current group member count. Any extra percent after the decimal point is always ignored. If the resulting amount is zero, -1 or 1 is used depending upon whether the percentage was negative or positive respectively.
* RELATIVE - Scale the group up or down by the positive or negative value given in amount.
-
scaleTypeSpecified
protected boolean scaleTypeSpecified
-
-
Method Detail
-
getAmount
public Long getAmount()
-
setAmount
public void setAmount(Long amount)
-
isAmountSpecified
public boolean isAmountSpecified()
-
unsetAmount
public void unsetAmount()
-
getScaleType
public String getScaleType()
-
setScaleType
public void setScaleType(String scaleType)
-
isScaleTypeSpecified
public boolean isScaleTypeSpecified()
-
unsetScaleType
public void unsetScaleType()
-
asService
public Scale.Service asService(ApiClient client)
-
service
public static Scale.Service service(ApiClient client)
-
service
public static Scale.Service service(ApiClient client, Long id)
-
-