Package com.softlayer.api.service.network.firewall.update

Interface Request.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Request

@ApiService("SoftLayer_Network_Firewall_Update_Request")
public static interface Request.Service
extends Service

The SoftLayer_Network_Firewall_Update_Request service can be used to create SoftLayer network component firewall rules update requests. Update requests are added to a transaction queue and are typically posted in about 60 seconds. After they are posted, they are listed as current rules via the [[SoftLayer Network Component Firewall]] service. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.

See Also:

SoftLayer_Network_Firewall_Update_Request

Method Summary

Modifier and Type	Method	Description
Request.ServiceAsync	asAsync()	Get an async version of this service
Request	createObject(Request templateObject)	Create a new firewall update request.
Interface	getAuthorizingUser()	The user that authorized this firewall update request.
Attribute	getFirewallUpdateRequestRuleAttributes()	Get the possible attribute values for a firewall update request rule.
Guest	getGuest()	The downstream virtual server that the rule set will be applied to.
Hardware	getHardware()	The downstream server that the rule set will be applied to.
Firewall	getNetworkComponentFirewall()	The network component firewall that the rule set will be applied to.
Request	getObject()	''getObject'' returns a SoftLayer_Network_Firewall_Update_Request object.
List<Rule>	getRules()	The group of rules contained within the update request.
void	setMask(Request.Mask mask)
Boolean	updateRuleNote(Rule fwRule, String note)
Request.Mask	withMask()	Use the existing mask on this service or create it if not present
Request.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

Request.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Request.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

Request.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(Request.Mask mask)

createObject

@ApiMethod
Request createObject(Request templateObject)

Create a new firewall update request. The SoftLayer_Network_Firewall_Update_Request object passed to this function must have at least one rule.

''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your firewall update request was unable to be created.

See Also:

SoftLayer_Network_Firewall_Update_Request::createObject

getFirewallUpdateRequestRuleAttributes

@ApiMethod
Attribute getFirewallUpdateRequestRuleAttributes()

Get the possible attribute values for a firewall update request rule. These are the valid values which may be submitted as rule parameters for a firewall update request.

''getFirewallUpdateRequestRuleAttributes'' returns a SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute object upon success.

See Also:

SoftLayer_Network_Firewall_Update_Request::getFirewallUpdateRequestRuleAttributes

getObject

@ApiMethod(instanceRequired=true)
Request getObject()

''getObject'' returns a SoftLayer_Network_Firewall_Update_Request object. You can only get historical objects for servers attached to your account that have a network firewall enabled. ''createObject'' inserts a new SoftLayer_Network_Firewall_Update_Request object. You can only insert requests for servers attached to your account that have a network firewall enabled. ''getFirewallUpdateRequestRuleAttributes'' Get the possible attribute values for a firewall update request rule.

See Also:

SoftLayer_Network_Firewall_Update_Request::getObject

updateRuleNote

@ApiMethod
Boolean updateRuleNote(Rule fwRule,
                       String note)

See Also:

SoftLayer_Network_Firewall_Update_Request::updateRuleNote

getAuthorizingUser

@ApiMethod(instanceRequired=true)
Interface getAuthorizingUser()

The user that authorized this firewall update request.

See Also:

SoftLayer_Network_Firewall_Update_Request::getAuthorizingUser

getGuest

@ApiMethod(instanceRequired=true)
Guest getGuest()

The downstream virtual server that the rule set will be applied to.

See Also:

SoftLayer_Network_Firewall_Update_Request::getGuest

getHardware

@ApiMethod(instanceRequired=true)
Hardware getHardware()

The downstream server that the rule set will be applied to.

See Also:

SoftLayer_Network_Firewall_Update_Request::getHardware

getNetworkComponentFirewall

@ApiMethod(instanceRequired=true)
Firewall getNetworkComponentFirewall()

The network component firewall that the rule set will be applied to.

See Also:

SoftLayer_Network_Firewall_Update_Request::getNetworkComponentFirewall

getRules

@ApiMethod(instanceRequired=true)
List<Rule> getRules()

The group of rules contained within the update request.

See Also:

SoftLayer_Network_Firewall_Update_Request::getRules