org.openstack4j.api.gbp

Interface PolicyRuleService

All Known Implementing Classes:

PolicyRuleServiceImpl

public interface PolicyRuleService

This interface defines all methods for the manipulation of policy rule

Author:

vinod borole

Method Summary

Modifier and Type	Method and Description
PolicyRule	create(PolicyRule policyRule) Create a new policy rule
ActionResponse	delete(String id) Delete of the policy rule
PolicyRule	get(String id) Get the specified policy rule by ID
List<? extends PolicyRule>	list() List all policy rules
List<? extends PolicyRule>	list(Map<String,String> filteringParams) Returns list of policy rules filtered by parameters.
PolicyRule	update(String policyRuleId, PolicyRule policyRule) Updates an existing policy rule

Method Detail

list

List<? extends PolicyRule> list()

List all policy rules

Returns:

List of policy rules

list

List<? extends PolicyRule> list(Map<String,String> filteringParams)

Returns list of policy rules filtered by parameters.

Parameters:

filteringParams - map (name, value) of filtering parameters

get

PolicyRule get(String id)

Get the specified policy rule by ID

Parameters:

id - the policy rule id

Returns:

policy rule or null if not found

delete

ActionResponse delete(String id)

Delete of the policy rule

Parameters:

id - the policy rule id

Returns:

the rule response

create

PolicyRule create(PolicyRule policyRule)

Create a new policy rule

Parameters:

policy - rule

Returns:

the newly created policy rule

update

PolicyRule update(String policyRuleId,
                  PolicyRule policyRule)

Updates an existing policy rule

Parameters:

policy - rule identifier

policy - rule that is be used to updated

Returns:

the updated policy rule