org.openstack4j.openstack.networking.domain

Class NeutronSubnet

java.lang.Object

org.openstack4j.openstack.networking.domain.NeutronSubnet

All Implemented Interfaces:

Serializable, Buildable<SubnetBuilder>, BasicResource, IdEntity, Resource, ModelEntity, Subnet

Direct Known Subclasses:

NeutronSubnet.NeutronSubnetNoGateway

public class NeutronSubnet
extends Object
implements Subnet

A Subnet is a network with Pools and network based settings

Author:

Jeremy Unruh

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeutronSubnet.NeutronSubnetNoGateway
static class	NeutronSubnet.SubnetConcreteBuilder
static class	NeutronSubnet.Subnets

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 and Description
NeutronSubnet()
NeutronSubnet(String id, String name, boolean enableDHCP, String networkId, String tenantId, List<String> dnsNames, List<NeutronPool> pools, List<NeutronHostRoute> hostRoutes, IPVersionType ipVersion, String gateway, String cidr, Ipv6AddressMode ipv6AddressMode, Ipv6RaMode ipv6RaMode)

Method Summary

Modifier and Type	Method and Description
static SubnetBuilder	builder()
List<? extends Pool>	getAllocationPools()
String	getCidr()
List<String>	getDnsNames()
String	getGateway()
List<? extends HostRoute>	getHostRoutes()
String	getId()
Ipv6AddressMode	getIpv6AddressMode()
Ipv6RaMode	getIpv6RaMode()
IPVersionType	getIpVersion()
String	getName()
String	getNetworkId()
String	getTenantId()
boolean	isDHCPEnabled()
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
SubnetBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NeutronSubnet

public NeutronSubnet()

NeutronSubnet

public NeutronSubnet(String id,
                     String name,
                     boolean enableDHCP,
                     String networkId,
                     String tenantId,
                     List<String> dnsNames,
                     List<NeutronPool> pools,
                     List<NeutronHostRoute> hostRoutes,
                     IPVersionType ipVersion,
                     String gateway,
                     String cidr,
                     Ipv6AddressMode ipv6AddressMode,
                     Ipv6RaMode ipv6RaMode)

Method Detail

builder

public static SubnetBuilder builder()

toBuilder

public SubnetBuilder toBuilder()

Specified by:

toBuilder in interface Buildable<SubnetBuilder>

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

setName

public void setName(String name)

Sets the name for this resource

Specified by:

setName in interface BasicResource

Parameters:

name - the name to set

setTenantId

public void setTenantId(String tenantId)

Sets the tenant identifier

Specified by:

setTenantId in interface Resource

Parameters:

tenantId - the tenant id to set

getId

public String getId()

Specified by:

getId in interface IdEntity

Returns:

the identifier for this resource

getName

public String getName()

Specified by:

getName in interface BasicResource

Returns:

the name for this resource

isDHCPEnabled

public boolean isDHCPEnabled()

Specified by:

isDHCPEnabled in interface Subnet

Returns:

true if DHCP is enabled for this subnet, false if not.

getNetworkId

public String getNetworkId()

Specified by:

getNetworkId in interface Subnet

Returns:

the id of the network this subnet is associated with

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface Resource

Returns:

the tenant identifier for this resource

getDnsNames

public List<String> getDnsNames()

Specified by:

getDnsNames in interface Subnet

Returns:

the DNS server names/IP

getAllocationPools

public List<? extends Pool> getAllocationPools()

Specified by:

getAllocationPools in interface Subnet

Returns:

the sub-ranges of cidr available for dynamic allocation to ports

getHostRoutes

public List<? extends HostRoute> getHostRoutes()

Specified by:

getHostRoutes in interface Subnet

Returns:

the set of routes that should be used by devices with IPs from this subnet

getIpVersion

public IPVersionType getIpVersion()

Specified by:

getIpVersion in interface Subnet

Returns:

the ip version used by this subnet

getGateway

public String getGateway()

Specified by:

getGateway in interface Subnet

Returns:

the default gateway used by devices in this subnet

getCidr

public String getCidr()

Specified by:

getCidr in interface Subnet

Returns:

the cidr representing the IP range for this subnet, based on IP version

getIpv6AddressMode

public Ipv6AddressMode getIpv6AddressMode()

Specified by:

getIpv6AddressMode in interface Subnet

Returns:

The IPv6 address modes specifies mechanisms for assigning IP addresses

getIpv6RaMode

public Ipv6RaMode getIpv6RaMode()

Specified by:

getIpv6RaMode in interface Subnet

Returns:

the IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet

toString

public String toString()

Overrides:

toString in class Object