Package org.openstack4j.openstack.networking.domain

Class NeutronRouter

java.lang.Object

org.openstack4j.openstack.networking.domain.NeutronRouter

All Implemented Interfaces:

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

public class NeutronRouter
extends Object
implements Router

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NeutronRouter.RouterConcreteBuilder
static class	NeutronRouter.Routers

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Constructor Summary

Constructors

Constructor	Description
NeutronRouter()

Method Summary

Modifier and Type	Method	Description
static RouterBuilder	builder()
boolean	equals(Object obj)
Boolean	getDistributed()	true indicates a distributed router.
ExternalGateway	getExternalGatewayInfo()	Information on external gateway for the router
String	getId()
String	getName()
List<? extends HostRoute>	getRoutes()	Host Routing entries for the router
State	getStatus()	Indicates whether a router is currently operational or not
String	getTenantId()
int	hashCode()
boolean	isAdminStateUp()	Administrative state of the router
void	setId(String id)	Sets the identifier for this resource.
void	setName(String name)	Sets the name for this resource
void	setTenantId(String tenantId)	Sets the tenant identifier
RouterBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NeutronRouter

public NeutronRouter()

Method Detail

builder

public static RouterBuilder builder()

toBuilder

public RouterBuilder toBuilder()

Specified by:

toBuilder in interface Buildable<RouterBuilder>

getId

public String getId()

Specified by:

getId in interface IdEntity

Returns:

the identifier for this resource

setId

public void setId(String id)

Sets the identifier for this resource. Note: creating a new resource should not have the idenfier set since OpenStack will assign one on the create call

Specified by:

setId in interface IdEntity

Parameters:

id - the identifier

getName

public String getName()

Specified by:

getName in interface BasicResource

Returns:

the name for this resource

setName

public void setName(String name)

Sets the name for this resource

Specified by:

setName in interface BasicResource

Parameters:

name - the name to set

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface Resource

Returns:

the tenant identifier for this resource

setTenantId

public void setTenantId(String tenantId)

Sets the tenant identifier

Specified by:

setTenantId in interface Resource

Parameters:

tenantId - the tenant id to set

getRoutes

public List<? extends HostRoute> getRoutes()

Host Routing entries for the router

Specified by:

getRoutes in interface Router

Returns:

the routes for the router

isAdminStateUp

public boolean isAdminStateUp()

Administrative state of the router

Specified by:

isAdminStateUp in interface Router

Returns:

true, if the administrative state is up

getStatus

public State getStatus()

Indicates whether a router is currently operational or not

Specified by:

getStatus in interface Router

Returns:

the state/status of the router

getExternalGatewayInfo

public ExternalGateway getExternalGatewayInfo()

Information on external gateway for the router

Specified by:

getExternalGatewayInfo in interface Router

Returns:

the external gateway info

getDistributed

public Boolean getDistributed()

Description copied from interface: Router

true indicates a distributed router. It is available when dvr extension is enabled.

Specified by:

getDistributed in interface Router

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object