Package org.openstack4j.model.network.options

Class PortListOptions

java.lang.Object

org.openstack4j.model.network.options.PortListOptions

public class PortListOptions
extends Object

Provides server-side filtering options for listing ports

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method	Description
PortListOptions	adminState(boolean adminState)	The administrative state of the router, which is up (true) or down (false)
static PortListOptions	create()
PortListOptions	deviceId(String deviceId)	The ID of the device that uses this port.
PortListOptions	deviceOwner(String deviceOwner)	The ID of the entity that uses this port.
PortListOptions	displayName(String displayName)	Deprecated.
Map<String,String>	getOptions()
PortListOptions	macAddress(String macAddress)	The MAC address of the port
PortListOptions	name(String name)	The port name
PortListOptions	networkId(String networkId)	The ID of the attached network
PortListOptions	tenantId(String tenantId)	The ID of the tenant who owns the network

Methods inherited from class java.lang.Object

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

Method Detail

create

public static PortListOptions create()

deviceOwner

public PortListOptions deviceOwner(String deviceOwner)

The ID of the entity that uses this port. For example, a DHCP agent.

Parameters:

deviceOwner - the device owner

Returns:

options

deviceId

public PortListOptions deviceId(String deviceId)

The ID of the device that uses this port. For example, a virtual server.

Parameters:

deviceId - the device id

Returns:

options

networkId

public PortListOptions networkId(String networkId)

The ID of the attached network

Parameters:

networkId - the network id

Returns:

options

adminState

public PortListOptions adminState(boolean adminState)

The administrative state of the router, which is up (true) or down (false)

Parameters:

adminState - the admin state

Returns:

options

displayName

@Deprecated
public PortListOptions displayName(String displayName)

Deprecated.

DEPRECATED: This option is not valid anymore since neutron port does not have attribute named "display_name". Use name(String) to filter ports by name

Parameters:

displayName - the port display name

Returns:

options

name

public PortListOptions name(String name)

The port name

Parameters:

name - the port name

Returns:

options

tenantId

public PortListOptions tenantId(String tenantId)

The ID of the tenant who owns the network

Parameters:

tenantId - the tenant id

Returns:

options

macAddress

public PortListOptions macAddress(String macAddress)

The MAC address of the port

Parameters:

macAddress - the mac address

Returns:

options

getOptions

public Map<String,String> getOptions()