Package com.softlayer.api.service.scale
Interface Policy.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Policy
@ApiService("SoftLayer_Scale_Policy") public static interface Policy.Service extends Service
A scale policy is a combination of triggers and actions that can occur on a scale group. When any trigger is satisfied (or the policy is manually triggered) the actions will be executed.
- See Also:
- SoftLayer_Scale_Policy
-
Method Summary
Modifier and Type Method Description Policy.ServiceAsync
asAsync()
Get an async version of this servicePolicy
createObject(Policy templateObject)
Boolean
deleteObject()
Boolean
editObject(Policy templateObject)
List<Action>
getActions()
The actions to perform upon any trigger hit.Policy
getObject()
List<OneTime>
getOneTimeTriggers()
The one-time triggers to check for this group.List<Repeating>
getRepeatingTriggers()
The repeating triggers to check for this group.List<ResourceUse>
getResourceUseTriggers()
The resource-use triggers to check for this group.List<Scale>
getScaleActions()
The scale actions to perform upon any trigger hit.Group
getScaleGroup()
The group this policy is on.List<Trigger>
getTriggers()
The triggers to check for this group.void
setMask(Policy.Mask mask)
List<Member>
trigger()
Manually trigger the actions on this policy.Policy.Mask
withMask()
Use the existing mask on this service or create it if not presentPolicy.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Policy.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Policy.Mask withNewMask()Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Policy.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
createObject
- See Also:
- SoftLayer_Scale_Policy::createObject
-
deleteObject
- See Also:
- SoftLayer_Scale_Policy::deleteObject
-
editObject
- See Also:
- SoftLayer_Scale_Policy::editObject
-
getObject
- See Also:
- SoftLayer_Scale_Policy::getObject
-
trigger
Manually trigger the actions on this policy. Returns members if the trigger has an effect, or an empty set of members if there is no effect. Sometimes this may not have an effect if the group is not active, in cooldown, or the result would violate the group range. If this call fails, the group is suspended, the failure logged, and a ticket is created.- See Also:
- SoftLayer_Scale_Policy::trigger
-
getActions
The actions to perform upon any trigger hit. Currently this must be a single value.- See Also:
- SoftLayer_Scale_Policy::getActions
-
getOneTimeTriggers
The one-time triggers to check for this group. -
getRepeatingTriggers
The repeating triggers to check for this group. -
getResourceUseTriggers
The resource-use triggers to check for this group. -
getScaleActions
The scale actions to perform upon any trigger hit. Currently this must be a single value.- See Also:
- SoftLayer_Scale_Policy::getScaleActions
-
getScaleGroup
The group this policy is on.- See Also:
- SoftLayer_Scale_Policy::getScaleGroup
-
getTriggers
The triggers to check for this group.- See Also:
- SoftLayer_Scale_Policy::getTriggers
-