org.openstack4j.openstack.networking.domain

Class NeutronPort

java.lang.Object

org.openstack4j.openstack.networking.domain.NeutronPort

All Implemented Interfaces:

Serializable, Buildable<PortBuilder>, BasicResource, IdEntity, Resource, ModelEntity, Port

public class NeutronPort
extends Object
implements Port

A Neutron Port

Author:

Jeremy Unruh

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeutronPort.PortConcreteBuilder
static class	NeutronPort.Ports

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
NeutronPort()

Method Summary

Modifier and Type	Method and Description
static PortBuilder	builder()
Set<? extends AllowedAddressPair>	getAllowedAddressPairs()
String	getDeviceId()
String	getDeviceOwner()
Set<? extends IP>	getFixedIps()
String	getHostId()
String	getId()
String	getMacAddress()
String	getName()
String	getNetworkId()
Map<String,Object>	getProfile()
List<String>	getSecurityGroups()
State	getState()
String	getTenantId()
Map<String,Object>	getVifDetails()
String	getVifType()
String	getvNicType()
boolean	isAdminStateUp()
Boolean	isPortSecurityEnabled()
void	setHostId(String hostId)
void	setId(String id) Sets the identifier for this resource.
void	setName(String name) Sets the name for this resource
void	setProfile(Map<String,Object> profile)
void	setTenantId(String tenantId) Sets the tenant identifier
void	setVifDetails(Map<String,Object> vifDetails)
void	setVifType(String vifType)
void	setvNicType(String vNicType)
PortBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronPort

public NeutronPort()

Method Detail

builder

public static PortBuilder builder()

toBuilder

public PortBuilder toBuilder()

Specified by:

toBuilder in interface Buildable<PortBuilder>

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

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface Resource

Returns:

the tenant identifier for this resource

getState

public State getState()

Specified by:

getState in interface Port

Returns:

the current state of the port

isAdminStateUp

public boolean isAdminStateUp()

Specified by:

isAdminStateUp in interface Port

Returns:

the administrative state of port. If false, port does not forward packets.

getNetworkId

public String getNetworkId()

Specified by:

getNetworkId in interface Port

Returns:

the id of the network where this port is associated with

getDeviceId

public String getDeviceId()

Specified by:

getDeviceId in interface Port

Returns:

the id of the device (e.g. server) using this port.

getDeviceOwner

public String getDeviceOwner()

Specified by:

getDeviceOwner in interface Port

Returns:

the entity (e.g.: DHCP Agent) using this port.

getFixedIps

public Set<? extends IP> getFixedIps()

Specified by:

getFixedIps in interface Port

Returns:

the set of fixed IPs this port has been assigned

getAllowedAddressPairs

public Set<? extends AllowedAddressPair> getAllowedAddressPairs()

Specified by:

getAllowedAddressPairs in interface Port

getMacAddress

public String getMacAddress()

Specified by:

getMacAddress in interface Port

Returns:

the MacAddress of this port

getSecurityGroups

public List<String> getSecurityGroups()

Specified by:

getSecurityGroups in interface Port

Returns:

the security group identifiers assigned to this port

getHostId

public String getHostId()

Specified by:

getHostId in interface Port

getVifType

public String getVifType()

Specified by:

getVifType in interface Port

getVifDetails

public Map<String,Object> getVifDetails()

Specified by:

getVifDetails in interface Port

getvNicType

public String getvNicType()

Specified by:

getvNicType in interface Port

getProfile

public Map<String,Object> getProfile()

Specified by:

getProfile in interface Port

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

setHostId

public void setHostId(String hostId)

setVifType

public void setVifType(String vifType)

setVifDetails

public void setVifDetails(Map<String,Object> vifDetails)

setvNicType

public void setvNicType(String vNicType)

setProfile

public void setProfile(Map<String,Object> profile)

isPortSecurityEnabled

public Boolean isPortSecurityEnabled()

Specified by:

isPortSecurityEnabled in interface Port

Returns:

The port security status. A valid value is enabled (true) or disabled (false).

toString

public String toString()

Overrides:

toString in class Object