Interface LbPool
-
- All Superinterfaces:
Buildable<LbPoolBuilder>,ModelEntity,Serializable
- All Known Implementing Classes:
NeutronLbPool
public interface LbPool extends ModelEntity, Buildable<LbPoolBuilder>
A loadbanlance pool- Author:
- liujunpeng
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable
Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()List<String>getHealthMonitors()StringgetId()LbMethodgetLbMethod()List<String>getMembers()StringgetName()ProtocolgetProtocol()StringgetProvider()StringgetStatus()StringgetSubnetId()StringgetTenantId()StringgetVipId()booleanisAdminStateUp()
-
-
-
Method Detail
-
getId
String getId()
- Returns:
- id. The unique ID for the pool.
-
getTenantId
String getTenantId()
- Returns:
- tenantId. Owner of the pool. Only an administrative user can specify a tenant ID other than its own.
-
getVipId
String getVipId()
- Returns:
- vip Id.
-
getName
String getName()
- Returns:
- Pool name. Does not have to be unique.
-
getDescription
String getDescription()
- Returns:
- Description for the pool.
-
getSubnetId
String getSubnetId()
- Returns:
- subnetId The ID of the subnet on which to allocate the VIP address.
-
getProtocol
Protocol getProtocol()
- Returns:
- The protocol of the pool, which is TCP, HTTP, or HTTPS.
-
getProvider
String getProvider()
- Returns:
- loadbalance provider,such as haproxy
-
getLbMethod
LbMethod getLbMethod()
- Returns:
- The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round-robin must be supported.
-
getHealthMonitors
List<String> getHealthMonitors()
- Returns:
- List of health monitors that associated to the pool.
-
isAdminStateUp
boolean isAdminStateUp()
- Returns:
- The administrative state of the lb pool, which is up (true) or down (false).
-
getStatus
String getStatus()
- Returns:
- status The status of the lb pool. Indicates whether the lb pool is operational.
-
-