Port (Apache jclouds 1.9.3 API)

java.lang.Object
- org.jclouds.openstack.neutron.v2.domain.Port

Direct Known Subclasses:

Port.CreatePort, Port.UpdatePort
```
public class Port
extends Object
```
A Neutron port

See Also:
api doc

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Port.CreateBuilder` Create and Update builders (inheriting from Builder)
`static class`	`Port.CreatePort` Create and Update options - extend the domain class, passed to API update and create calls.
`static class`	`Port.UpdateBuilder` Create and Update builders (inheriting from Builder)
`static class`	`Port.UpdatePort` Create and Update options - extend the domain class, passed to API update and create calls.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	Port(String id, NetworkStatus status, VIFType vifType, com.google.common.collect.ImmutableMap<String,Object> vifDetails, String qosQueueId, String name, String networkId, Boolean adminStateUp, String macAddress, com.google.common.collect.ImmutableSet<IP> fixedIps, String deviceId, String deviceOwner, String tenantId, com.google.common.collect.ImmutableSet<String> securityGroups, com.google.common.collect.ImmutableSet<AddressPair> allowedAddressPairs, com.google.common.collect.ImmutableSet<ExtraDhcpOption> extraDhcpOptions, VNICType vnicType, String hostId, com.google.common.collect.ImmutableMap<String,Object> profile, Boolean portSecurity, String profileId, Boolean macLearning, Integer qosRxtxFactor)

Method Summary

Methods
Modifier and Type	Method and Description
`static Port.CreateBuilder`	`createBuilder(String networkId)`
`boolean`	`equals(Object o)`
`Boolean`	`getAdminStateUp()`
`com.google.common.collect.ImmutableSet<AddressPair>`	`getAllowedAddressPairs()`
`String`	`getDeviceId()`
`String`	`getDeviceOwner()`
`com.google.common.collect.ImmutableSet<ExtraDhcpOption>`	`getExtraDhcpOptions()`
`com.google.common.collect.ImmutableSet<IP>`	`getFixedIps()`
`String`	`getHostId()`
`String`	`getId()`
`String`	`getMacAddress()`
`Boolean`	`getMacLearning()`
`String`	`getName()`
`String`	`getNetworkId()`
`Boolean`	`getPortSecurity()`
`com.google.common.collect.ImmutableMap<String,Object>`	`getProfile()`
`String`	`getProfileId()`
`String`	`getQosQueueId()`
`Integer`	`getQosRxtxFactor()`
`com.google.common.collect.ImmutableSet<String>`	`getSecurityGroups()`
`NetworkStatus`	`getStatus()`
`String`	`getTenantId()`
`com.google.common.collect.ImmutableMap<String,Object>`	`getVifDetails()`
`VIFType`	`getVifType()`
`VNICType`	`getVnicType()`
`int`	`hashCode()`
`String`	`toString()`
`static Port.UpdateBuilder`	`updateBuilder()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Port

@ConstructorProperties(value={"id","status","binding:vif_type","binding:vif_details","queue_id","name","network_id","admin_state_up","mac_address","fixed_ips","device_id","device_owner","tenant_id","security_groups","allowed_address_pairs","extra_dhcp_opts","binding:vnic_type","binding:host_id","binding:profile","port_security_enabled","n1kv:profile_id","mac_learning_enabled","rxtx_factor"})
protected Port(String id,
                               NetworkStatus status,
                               VIFType vifType,
                               com.google.common.collect.ImmutableMap<String,Object> vifDetails,
                               String qosQueueId,
                               String name,
                               String networkId,
                               Boolean adminStateUp,
                               String macAddress,
                               com.google.common.collect.ImmutableSet<IP> fixedIps,
                               String deviceId,
                               String deviceOwner,
                               String tenantId,
                               com.google.common.collect.ImmutableSet<String> securityGroups,
                               com.google.common.collect.ImmutableSet<AddressPair> allowedAddressPairs,
                               com.google.common.collect.ImmutableSet<ExtraDhcpOption> extraDhcpOptions,
                               VNICType vnicType,
                               String hostId,
                               com.google.common.collect.ImmutableMap<String,Object> profile,
                               Boolean portSecurity,
                               String profileId,
                               Boolean macLearning,
                               Integer qosRxtxFactor)

Method Detail
- getId
```
@Nullable
public String getId()
```
  Returns:
  the id of the Port
- getStatus
```
@Nullable
public NetworkStatus getStatus()
```
  Returns:
  the status of the Port
- getVifType
```
@Nullable
public VIFType getVifType()
```
  Returns:
  the vifType of the Port. Visible to only administrative users.
- getVifDetails
```
@Nullable
public com.google.common.collect.ImmutableMap<String,Object> getVifDetails()
```
  Returns:
  the vifDetails of the Port. A dictionary that enables the application to pass information about functions that Networking API v2.0 provides. Specify the following value: port_filter : Boolean to define whether Networking API v2.0 provides port filtering features such as security group and anti-MAC/IP spoofing. Visible to only administrative users.
- getQosQueueId
```
@Nullable
public String getQosQueueId()
```
  Returns:
  the qosQueueId of the Port
- getName
```
@Nullable
public String getName()
```
  Returns:
  the name of the Port
- getNetworkId
```
@Nullable
public String getNetworkId()
```
  Returns:
  the id of the network where this port is associated with.
- getAdminStateUp
```
@Nullable
public Boolean getAdminStateUp()
```
  Returns:
  the administrative state of port. If false, port does not forward packets.
- getMacAddress
```
@Nullable
public String getMacAddress()
```
  Returns:
  the macAddress of the Port
- getFixedIps
```
@Nullable
public com.google.common.collect.ImmutableSet<IP> getFixedIps()
```
  Returns:
  the set of fixed ips this port has been assigned.
- getDeviceId
```
@Nullable
public String getDeviceId()
```
  Returns:
  the id of the device (e.g. server) using this port.
- getDeviceOwner
```
@Nullable
public String getDeviceOwner()
```
  Returns:
  the entity (e.g.: dhcp agent) using this port.
- getTenantId
```
@Nullable
public String getTenantId()
```
  Returns:
  the tenantId of the Port
- getSecurityGroups
```
@Nullable
public com.google.common.collect.ImmutableSet<String> getSecurityGroups()
```
  Returns:
  the set of security groups
- getAllowedAddressPairs
```
@Nullable
public com.google.common.collect.ImmutableSet<AddressPair> getAllowedAddressPairs()
```
  Returns:
  the allowedAddressPairs of the Port
- getExtraDhcpOptions
```
@Nullable
public com.google.common.collect.ImmutableSet<ExtraDhcpOption> getExtraDhcpOptions()
```
  Returns:
  the extraDhcpOptions of the Port
- getVnicType
```
@Nullable
public VNICType getVnicType()
```
  Returns:
  the vnicType of the Port. This extended attribute is visible to only port owners and administrative users. Specifies a value of normal (virtual nic), direct (pci passthrough), or macvtap (virtual interface with a tap-like software interface). These values support SR-IOV PCI passthrough networking. The ML2 plug-in supports the vnic_type.
- getHostId
```
@Nullable
public String getHostId()
```
  Returns:
  the hostId of the Port. The ID of the host where the port is allocated. In some cases, different implementations can run on different hosts. Visible to only administrative users.
- getProfile
```
@Nullable
public com.google.common.collect.ImmutableMap<String,Object> getProfile()
```
  Returns:
  the profile of the Port. A dictionary that enables the application to pass information about functions that the Networking API provides. To enable or disable port filtering features such as security group and anti-MAC/IP spoofing, specify port_filter: True or port_filter: False. Visible to only administrative users.
- getPortSecurity
```
@Nullable
public Boolean getPortSecurity()
```
  Returns:
  the portSecurity of the Port
- getProfileId
```
@Nullable
public String getProfileId()
```
  Returns:
  the profileId of the Port
- getMacLearning
```
@Nullable
public Boolean getMacLearning()
```
  Returns:
  the macLearning of the Port
- getQosRxtxFactor
```
@Nullable
public Integer getQosRxtxFactor()
```
  Returns:
  the qosRxtxFactor of the Port
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- createBuilder
```
public static Port.CreateBuilder createBuilder(String networkId)
```
  Returns:
  the Builder for creating a new Router
- updateBuilder
```
public static Port.UpdateBuilder updateBuilder()
```
  Returns:
  the Builder for updating a Router

Class Port

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Port

Method Detail

getId

getStatus

getVifType

getVifDetails

getQosQueueId

getName

getNetworkId

getAdminStateUp

getMacAddress

getFixedIps

getDeviceId

getDeviceOwner

getTenantId

getSecurityGroups

getAllowedAddressPairs

getExtraDhcpOptions

getVnicType

getHostId

getProfile

getPortSecurity

getProfileId

getMacLearning

getQosRxtxFactor

equals

hashCode

toString

createBuilder

updateBuilder