org.openstack4j.model.network

Interface Router

All Superinterfaces:

BasicResource, Buildable<RouterBuilder>, IdEntity, ModelEntity, Resource, Serializable

All Known Implementing Classes:

NeutronRouter

public interface Router
extends Resource, Buildable<RouterBuilder>

A router is used to interconnect subnets and forward traffic among them. Another feature of the router is to NAT internal traffic to external networks.

Author:

Jeremy Unruh

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
ExternalGateway	getExternalGatewayInfo() Information on external gateway for the router
List<? extends HostRoute>	getRoutes() Host Routing entries for the router
State	getStatus() Indicates whether a router is currently operational or not
boolean	isAdminStateUp() Administrative state of the router

Methods inherited from interface org.openstack4j.model.common.Resource

getTenantId, setTenantId

Methods inherited from interface org.openstack4j.model.common.BasicResource

getName, setName

Methods inherited from interface org.openstack4j.model.common.IdEntity

getId, setId

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getRoutes

List<? extends HostRoute> getRoutes()

Host Routing entries for the router

Returns:

the routes for the router

isAdminStateUp

boolean isAdminStateUp()

Administrative state of the router

Returns:

true, if the administrative state is up

getStatus

State getStatus()

Indicates whether a router is currently operational or not

Returns:

the state/status of the router

getExternalGatewayInfo

ExternalGateway getExternalGatewayInfo()

Information on external gateway for the router

Returns:

the external gateway info