org.openstack4j.api.networking

Interface PortService

All Superinterfaces:

RestService

All Known Implementing Classes:

PortServiceImpl

public interface PortService
extends RestService

OpenStack (Neutron) Port based Operations

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
Port	create(Port port) Creates a new Port
ActionResponse	delete(String portId) Delete a Port by ID
Port	get(String portId) Gets the Port by ID
List<? extends Port>	list() Lists all Ports authorized by the current Tenant
List<? extends Port>	list(PortListOptions options) Lists all Ports authorized by the current Tenant
Port	update(Port port) Updates an existing Port.

Method Detail

list

List<? extends Port> list()

Lists all Ports authorized by the current Tenant

Returns:

the list of ports

list

List<? extends Port> list(PortListOptions options)

Lists all Ports authorized by the current Tenant

Parameters:

options - filtering options

Returns:

the list of ports

get

Port get(String portId)

Gets the Port by ID

Parameters:

portId - the port identifier

Returns:

the port or null if not found

delete

ActionResponse delete(String portId)

Delete a Port by ID

Parameters:

portId - the port identifier to delete

Returns:

the action response

create

Port create(Port port)

Creates a new Port

Parameters:

port - the port to create

Returns:

the newly create Port

update

Port update(Port port)

Updates an existing Port. The Port identifier must be set on the port object to be successful

Parameters:

port - the port to update

Returns:

the updated port