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 service
Policy	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 present
Policy.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Policy.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface 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 interface Maskable

withMask

Policy.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Policy.Mask mask)

createObject

@ApiMethod
Policy createObject(Policy templateObject)

See Also:

SoftLayer_Scale_Policy::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

See Also:

SoftLayer_Scale_Policy::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Policy templateObject)

See Also:

SoftLayer_Scale_Policy::editObject

getObject

@ApiMethod(instanceRequired=true)
Policy getObject()

See Also:

SoftLayer_Scale_Policy::getObject

trigger

@ApiMethod(instanceRequired=true)
List<Member> 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

@ApiMethod(instanceRequired=true)
List<Action> getActions()

The actions to perform upon any trigger hit. Currently this must be a single value.

See Also:

SoftLayer_Scale_Policy::getActions

getOneTimeTriggers

@ApiMethod(instanceRequired=true)
List<OneTime> getOneTimeTriggers()

The one-time triggers to check for this group.

See Also:

SoftLayer_Scale_Policy::getOneTimeTriggers

getRepeatingTriggers

@ApiMethod(instanceRequired=true)
List<Repeating> getRepeatingTriggers()

The repeating triggers to check for this group.

See Also:

SoftLayer_Scale_Policy::getRepeatingTriggers

getResourceUseTriggers

@ApiMethod(instanceRequired=true)
List<ResourceUse> getResourceUseTriggers()

The resource-use triggers to check for this group.

See Also:

SoftLayer_Scale_Policy::getResourceUseTriggers

getScaleActions

@ApiMethod(instanceRequired=true)
List<Scale> getScaleActions()

The scale actions to perform upon any trigger hit. Currently this must be a single value.

See Also:

SoftLayer_Scale_Policy::getScaleActions

getScaleGroup

@ApiMethod(instanceRequired=true)
Group getScaleGroup()

The group this policy is on.

See Also:

SoftLayer_Scale_Policy::getScaleGroup

getTriggers

@ApiMethod(instanceRequired=true)
List<Trigger> getTriggers()

The triggers to check for this group.

See Also:

SoftLayer_Scale_Policy::getTriggers