org.onosproject.net.pi.model

Interface PiActionModel

@Beta
public interface PiActionModel

Model of an action with runtime parameters in a protocol-independent pipeline.

Method Summary

Modifier and Type	Method and Description
PiActionId	id() Returns the ID of the action.
java.util.Optional<PiActionParamModel>	param(PiActionParamId paramId) Returns the model of the action's parameter defined by the given ID, if present.
java.util.Collection<PiActionParamModel>	params() Returns the collection of all parameter models for the action, or an empty collection if this action has no parameters.

Method Detail

id

PiActionId id()

Returns the ID of the action.

Returns:

action ID

param

java.util.Optional<PiActionParamModel> param(PiActionParamId paramId)

Returns the model of the action's parameter defined by the given ID, if present.

Parameters:

paramId - parameter ID

Returns:

action parameter model

params

java.util.Collection<PiActionParamModel> params()

Returns the collection of all parameter models for the action, or an empty collection if this action has no parameters.

Returns:

collection of action parameter models