NeutronPort (OpenStack4j Core 3.9 API)

java.lang.Object
- org.openstack4j.openstack.networking.domain.NeutronPort

All Implemented Interfaces:

Serializable, Buildable<PortBuilder>, BasicResource, IdEntity, Resource, TimeEntity, 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<?>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`NeutronPort.PortConcreteBuilder`
`static class`	`NeutronPort.Ports`

Constructor Summary

Constructors
Constructor and Description

NeutronPort()

Constructors
Constructor and Description
`NeutronPort()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PortBuilder`	`builder()`
`boolean`	`equals(Object obj)`
`Set<? extends AllowedAddressPair>`	`getAllowedAddressPairs()`
`Date`	`getCreatedTime()` created time
`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()`
`String`	`getTrunkPortParentId()`
`String`	`getTrunkPortType()`
`String`	`getTrunkPortVlanId()`
`Date`	`getUpdatedTime()` updated time
`Map<String,Object>`	`getVifDetails()`
`String`	`getVifType()`
`String`	`getvNicType()`
`int`	`hashCode()`
`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, finalize, getClass, 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
  - 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
  - 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
  - setHostId
```
public void setHostId(String hostId)
```
  - getVifType
```
public String getVifType()
```
    Specified by:
    
    getVifType in interface Port
  - setVifType
```
public void setVifType(String vifType)
```
  - getVifDetails
```
public Map<String,Object> getVifDetails()
```
    Specified by:
    
    getVifDetails in interface Port
  - setVifDetails
```
public void setVifDetails(Map<String,Object> vifDetails)
```
  - getvNicType
```
public String getvNicType()
```
    Specified by:
    
    getvNicType in interface Port
  - setvNicType
```
public void setvNicType(String vNicType)
```
  - getProfile
```
public Map<String,Object> getProfile()
```
    Specified by:
    
    getProfile in interface Port
  - setProfile
```
public void setProfile(Map<String,Object> profile)
```
  - getTrunkPortParentId
```
public String getTrunkPortParentId()
```
    Specified by:
    
    getTrunkPortParentId in interface Port
    
    Returns:
    
    the parent ID of this port
  - getTrunkPortType
```
public String getTrunkPortType()
```
    Specified by:
    
    getTrunkPortType in interface Port
    
    Returns:
    
    the trunk port type of this port
  - getTrunkPortVlanId
```
public String getTrunkPortVlanId()
```
    Specified by:
    
    getTrunkPortVlanId in interface Port
    
    Returns:
    
    the Vlan of this port
  - getCreatedTime
```
public Date getCreatedTime()
```
    Description copied from interface: TimeEntity
    
    created time
    
    Specified by:
    
    getCreatedTime in interface TimeEntity
    
    Returns:
    
    created time
  - getUpdatedTime
```
public Date getUpdatedTime()
```
    Description copied from interface: TimeEntity
    
    updated time
    
    Specified by:
    
    getUpdatedTime in interface TimeEntity
    
    Returns:
    
    updated time
  - 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class NeutronPort

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NeutronPort

Method Detail

builder

toBuilder

getId

setId

getName

setName

getTenantId

setTenantId

getState

isAdminStateUp

getNetworkId

getDeviceId

getDeviceOwner

getFixedIps

getAllowedAddressPairs

getMacAddress

getSecurityGroups

getHostId

setHostId

getVifType

setVifType

getVifDetails

setVifDetails

getvNicType

setvNicType

getProfile

setProfile

getTrunkPortParentId

getTrunkPortType

getTrunkPortVlanId

getCreatedTime

getUpdatedTime

isPortSecurityEnabled

toString

hashCode

equals