org.openstack4j.model.network.ext

Interface Vip

All Superinterfaces:

Buildable<VipBuilder>, ModelEntity, Serializable

All Known Implementing Classes:

NeutronVip

public interface Vip
extends ModelEntity, Buildable<VipBuilder>

a vip of a 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

Modifier and Type	Method and Description
String	getAddress()
Integer	getConnectionLimit()
String	getDescription()
String	getId()
String	getName()
String	getPoolId()
String	getProtocol()
Integer	getProtocolPort()
SessionPersistence	getSessionPersistence()
String	getStatus()
String	getSubnetId()
String	getTenantId()
boolean	isAdminStateUp()

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getAddress

String getAddress()

Returns:

The IP address of the VIP.

isAdminStateUp

boolean isAdminStateUp()

Returns:

The administrative state of the VIP. A valid value is true (UP) or false (DOWN).

getConnectionLimit

Integer getConnectionLimit()

Returns:

connectionLimit.The maximum number of connections allowed for the VIP. Default is -1, meaning no limit.

getDescription

String getDescription()

Returns:

Human-readable description for the VIP

getId

String getId()

Returns:

The unique ID for the VIP.

getName

String getName()

Returns:

Human-readable name for the VIP. Does not have to be unique.

getPoolId

String getPoolId()

Returns:

The ID of the pool with which the VIP is associated.

getProtocol

String getProtocol()

Returns:

The protocol of the VIP address. A valid value is TCP, HTTP, or HTTPS.

getProtocolPort

Integer getProtocolPort()

Returns:

The port on which to listen to client traffic that is associated with the VIP address. A valid value is from 1 to 65535.

getSessionPersistence

SessionPersistence getSessionPersistence()

Returns:

SessionPersistence.Session persistence parameters for the VIP. Omit the session_persistence parameter to prevent session persistence. When no session persistence is used, the session_persistence parameter does not appear in the API response. To clear session persistence for the VIP, set the session_persistence parameter to null in a VIP update request.

getStatus

String getStatus()

Returns:

status.The status of the VIP. Indicates whether the VIP is operational.

getSubnetId

String getSubnetId()

Returns:

The ID of the subnet on which to allocate the VIP address.

getTenantId

String getTenantId()

Returns:

The Tenant Id.Owner of the VIP.