org.openstack4j.api.octavia

Interface LbPoolV2Service

All Superinterfaces:

RestService

All Known Implementing Classes:

LbPoolV2ServiceImpl

public interface LbPoolV2Service
extends RestService

Octavia V2 pool Extension API

Author:

wei

Method Summary

Modifier and Type	Method and Description
LbPoolV2	create(LbPoolV2 lbPool) Create a lb Pool
MemberV2	createMember(String lbPoolId, MemberV2 member) Create a member
ActionResponse	delete(String lbPoolId) Delete the specified lb Pool by ID
ActionResponse	deleteMember(String lbPoolId, String memberId) Delete the specified member by ID
LbPoolV2	get(String lbPoolId) Get the specified lb pool by ID
MemberV2	getMember(String lbPoolId, String memberId) Get the specified member by ID
List<? extends LbPoolV2>	list() List all lb pools that the current tenant has access to
List<? extends LbPoolV2>	list(Map<String,String> filteringParams) Returns list of lb v2 pools filtered by parameters.
List<? extends MemberV2>	listMembers(String lbPoolId) List all members that the current tenant has access to
List<? extends MemberV2>	listMembers(String lbPoolId, Map<String,String> filteringParams) Returns list of member filtered by parameters.
LbPoolV2	update(String lbPoolId, LbPoolV2Update lbPool) Update a lb pool
MemberV2	updateMember(String lbPoolId, String memberId, MemberV2Update member) Update a member

Method Detail

list

List<? extends LbPoolV2> list()

List all lb pools that the current tenant has access to

Returns:

list of all lb pools

list

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

Returns list of lb v2 pools filtered by parameters.

Parameters:

filteringParams - map (name, value) of filtering parameters

Returns:

List

get

LbPoolV2 get(String lbPoolId)

Get the specified lb pool by ID

Parameters:

lbPoolId - the lb v2 pool identifier

Returns:

the lbPoolV2 or null if not found

delete

ActionResponse delete(String lbPoolId)

Delete the specified lb Pool by ID

Parameters:

lbPoolId - the lb pool identifier

Returns:

the action response

create

LbPoolV2 create(LbPoolV2 lbPool)

Create a lb Pool

Parameters:

lbPool - LbPool

Returns:

lbPoolV2

update

LbPoolV2 update(String lbPoolId,
                LbPoolV2Update lbPool)

Update a lb pool

Parameters:

lbPoolId - the lb pool identifier

lbPool - LbPoolV2Update

Returns:

LbPoolV2

listMembers

List<? extends MemberV2> listMembers(String lbPoolId)

List all members that the current tenant has access to

Parameters:

lbPoolId - the load balancer pool

Returns:

list of all Member

listMembers

List<? extends MemberV2> listMembers(String lbPoolId,
                                     Map<String,String> filteringParams)

Returns list of member filtered by parameters.

Parameters:

lbPoolId - the load balancer pool

filteringParams - map (name, value) of filtering parameters

Returns:

getMember

MemberV2 getMember(String lbPoolId,
                   String memberId)

Get the specified member by ID

Parameters:

lbPoolId - the load balancer pool

memberId - the member identifier

Returns:

the member or null if not found

createMember

MemberV2 createMember(String lbPoolId,
                      MemberV2 member)

Create a member

Parameters:

lbPoolId - the load balancer pool

member - Member

Returns:

Member

deleteMember

ActionResponse deleteMember(String lbPoolId,
                            String memberId)

Delete the specified member by ID

Parameters:

lbPoolId - the load balancer pool

memberId - the member identifier

Returns:

the action response

updateMember

MemberV2 updateMember(String lbPoolId,
                      String memberId,
                      MemberV2Update member)

Update a member

Parameters:

lbPoolId - the load balancer pool

memberId - the member identifier

member - MemberUpdate

Returns:

Member