FlowDocument (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.flows.elastic.FlowDocument

```
public class FlowDocument
extends Object
```
Member variables are sorted by the value of the @SerializedName annotation.

Constructor Summary

Constructors
Constructor and Description

FlowDocument()

FlowDocument(Flow flow)

Constructors
Constructor and Description
`FlowDocument()`
`FlowDocument(Flow flow)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHost(String host)`
`static EnrichedFlow`	`buildEnrichedFlow(FlowDocument flowDocument)`
`static FlowDocument`	`from(Flow flow)`
`String`	`getApplication()`
`Long`	`getBytes()`
`long`	`getClockCorrection()`
`String`	`getConvoKey()`
`Long`	`getDeltaSwitched()`
`Direction`	`getDirection()`
`String`	`getDstAddr()`
`String`	`getDstAddrHostname()`
`Long`	`getDstAs()`
`Locality`	`getDstLocality()`
`Integer`	`getDstMaskLen()`
`Integer`	`getDstPort()`
`Integer`	`getEngineId()`
`Integer`	`getEngineType()`
`Long`	`getFirstSwitched()`
`Flow`	`getFlow()`
`Locality`	`getFlowLocality()`
`int`	`getFlowRecords()`
`long`	`getFlowSeqNum()`
`String`	`getHost()`
`Set<String>`	`getHosts()`
`Integer`	`getInputSnmp()`
`Integer`	`getIpProtocolVersion()`
`Long`	`getLastSwitched()`
`String`	`getLocation()`
`NetflowVersion`	`getNetflowVersion()`
`String`	`getNextHop()`
`String`	`getNextHopHostname()`
`NodeDocument`	`getNodeDst()`
`NodeDocument`	`getNodeExporter()`
`NodeDocument`	`getNodeSrc()`
`Integer`	`getOutputSnmp()`
`Long`	`getPackets()`
`Integer`	`getProtocol()`
`SamplingAlgorithm`	`getSamplingAlgorithm()`
`Double`	`getSamplingInterval()`
`String`	`getSrcAddr()`
`String`	`getSrcAddrHostname()`
`Long`	`getSrcAs()`
`Locality`	`getSrcLocality()`
`Integer`	`getSrcMaskLen()`
`Integer`	`getSrcPort()`
`Integer`	`getTcpFlags()`
`long`	`getTimestamp()`
`Integer`	`getTos()`
`Integer`	`getVersion()`
`String`	`getVlan()`
`void`	`setApplication(String application)`
`void`	`setBytes(Long bytes)`
`void`	`setClockCorrection(long clockCorrection)`
`void`	`setConvoKey(String convoKey)`
`void`	`setDeltaSwitched(Long deltaSwitched)`
`void`	`setDirection(Direction direction)`
`void`	`setDstAddr(String dstAddr)`
`void`	`setDstAddrHostname(String dstAddrHostname)`
`void`	`setDstAs(Long dstAs)`
`void`	`setDstLocality(Locality dstLocality)`
`void`	`setDstMaskLen(Integer dstMaskLen)`
`void`	`setDstPort(Integer dstPort)`
`void`	`setEngineId(Integer engineId)`
`void`	`setEngineType(Integer engineType)`
`void`	`setFirstSwitched(Long firstSwitched)`
`void`	`setFlow(Flow flow)`
`void`	`setFlowLocality(Locality flowLocality)`
`void`	`setFlowRecords(int flowRecords)`
`void`	`setFlowSeqNum(long flowSeqNum)`
`void`	`setHost(String host)`
`void`	`setHosts(Set<String> hosts)`
`void`	`setInputSnmp(Integer inputSnmp)`
`void`	`setIpProtocolVersion(Integer ipProtocolVersion)`
`void`	`setLastSwitched(Long lastSwitched)`
`void`	`setLocation(String location)`
`void`	`setNetflowVersion(NetflowVersion netflowVersion)`
`void`	`setNextHop(String nextHop)`
`void`	`setNextHopHostname(String nextHopHostname)`
`void`	`setNodeDst(NodeDocument nodeDst)`
`void`	`setNodeExporter(NodeDocument nodeExporter)`
`void`	`setNodeSrc(NodeDocument nodeSrc)`
`void`	`setOutputSnmp(Integer outputSnmp)`
`void`	`setPackets(Long packets)`
`void`	`setProtocol(Integer protocol)`
`void`	`setSamplingAlgorithm(SamplingAlgorithm samplingAlgorithm)`
`void`	`setSamplingInterval(Double samplingInterval)`
`void`	`setSrcAddr(String srcAddr)`
`void`	`setSrcAddrHostname(String srcAddrHostname)`
`void`	`setSrcAs(Long srcAs)`
`void`	`setSrcLocality(Locality srcLocality)`
`void`	`setSrcMaskLen(Integer srcMaskLen)`
`void`	`setSrcPort(Integer srcPort)`
`void`	`setTcpFlags(Integer tcpFlags)`
`void`	`setTimestamp(long timestamp)`
`void`	`setTos(Integer tos)`
`void`	`setVersion(Integer version)`
`void`	`setVlan(String vlan)`

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

Constructor Detail

FlowDocument
```
public FlowDocument(Flow flow)
```

FlowDocument
```
public FlowDocument()
```

Method Detail

addHost
```
public void addHost(String host)
```

getFlow
```
public Flow getFlow()
```

setFlow
```
public void setFlow(Flow flow)
```

getTimestamp
```
public long getTimestamp()
```

setTimestamp

public void setTimestamp(long timestamp)

getClockCorrection
```
public long getClockCorrection()
```

setClockCorrection

public void setClockCorrection(long clockCorrection)

getVersion
```
public Integer getVersion()
```

setVersion

public void setVersion(Integer version)

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getHosts
```
public Set<String> getHosts()
```

setHosts

public void setHosts(Set<String> hosts)

getLocation
```
public String getLocation()
```

setLocation

public void setLocation(String location)

getApplication
```
public String getApplication()
```

setApplication

public void setApplication(String application)

getBytes
```
public Long getBytes()
```

setBytes
```
public void setBytes(Long bytes)
```

getConvoKey
```
public String getConvoKey()
```

setConvoKey

public void setConvoKey(String convoKey)

getDirection
```
public Direction getDirection()
```

setDirection

public void setDirection(Direction direction)

getDstAddr
```
public String getDstAddr()
```

setDstAddr

public void setDstAddr(String dstAddr)

getDstAddrHostname
```
public String getDstAddrHostname()
```

setDstAddrHostname

public void setDstAddrHostname(String dstAddrHostname)

getDstAs
```
public Long getDstAs()
```

setDstAs
```
public void setDstAs(Long dstAs)
```

getDstLocality
```
public Locality getDstLocality()
```

setDstLocality

public void setDstLocality(Locality dstLocality)

getDstMaskLen
```
public Integer getDstMaskLen()
```

setDstMaskLen

public void setDstMaskLen(Integer dstMaskLen)

getDstPort
```
public Integer getDstPort()
```

setDstPort

public void setDstPort(Integer dstPort)

getEngineId
```
public Integer getEngineId()
```

setEngineId

public void setEngineId(Integer engineId)

getEngineType
```
public Integer getEngineType()
```

setEngineType

public void setEngineType(Integer engineType)

getFirstSwitched
```
public Long getFirstSwitched()
```

setFirstSwitched

public void setFirstSwitched(Long firstSwitched)

getFlowLocality
```
public Locality getFlowLocality()
```

setFlowLocality

public void setFlowLocality(Locality flowLocality)

getFlowRecords
```
public int getFlowRecords()
```

setFlowRecords

public void setFlowRecords(int flowRecords)

getFlowSeqNum
```
public long getFlowSeqNum()
```

setFlowSeqNum

public void setFlowSeqNum(long flowSeqNum)

getInputSnmp
```
public Integer getInputSnmp()
```

setInputSnmp

public void setInputSnmp(Integer inputSnmp)

getIpProtocolVersion
```
public Integer getIpProtocolVersion()
```

setIpProtocolVersion

public void setIpProtocolVersion(Integer ipProtocolVersion)

getLastSwitched
```
public Long getLastSwitched()
```

setLastSwitched

public void setLastSwitched(Long lastSwitched)

getNextHop
```
public String getNextHop()
```

setNextHop

public void setNextHop(String nextHop)

getNextHopHostname
```
public String getNextHopHostname()
```

setNextHopHostname

public void setNextHopHostname(String nextHopHostname)

getOutputSnmp
```
public Integer getOutputSnmp()
```

setOutputSnmp

public void setOutputSnmp(Integer outputSnmp)

getPackets
```
public Long getPackets()
```

setPackets
```
public void setPackets(Long packets)
```

getProtocol
```
public Integer getProtocol()
```

setProtocol

public void setProtocol(Integer protocol)

getSamplingAlgorithm

public SamplingAlgorithm getSamplingAlgorithm()

setSamplingAlgorithm

public void setSamplingAlgorithm(SamplingAlgorithm samplingAlgorithm)

getSamplingInterval
```
public Double getSamplingInterval()
```

setSamplingInterval

public void setSamplingInterval(Double samplingInterval)

getSrcAddr
```
public String getSrcAddr()
```

setSrcAddr

public void setSrcAddr(String srcAddr)

getSrcAddrHostname
```
public String getSrcAddrHostname()
```

setSrcAddrHostname

public void setSrcAddrHostname(String srcAddrHostname)

getSrcAs
```
public Long getSrcAs()
```

setSrcAs
```
public void setSrcAs(Long srcAs)
```

getSrcLocality
```
public Locality getSrcLocality()
```

setSrcLocality

public void setSrcLocality(Locality srcLocality)

getSrcMaskLen
```
public Integer getSrcMaskLen()
```

setSrcMaskLen

public void setSrcMaskLen(Integer srcMaskLen)

getSrcPort
```
public Integer getSrcPort()
```

setSrcPort

public void setSrcPort(Integer srcPort)

getTcpFlags
```
public Integer getTcpFlags()
```

setTcpFlags

public void setTcpFlags(Integer tcpFlags)

getDeltaSwitched
```
public Long getDeltaSwitched()
```

setDeltaSwitched

public void setDeltaSwitched(Long deltaSwitched)

getTos
```
public Integer getTos()
```

setTos
```
public void setTos(Integer tos)
```

getNetflowVersion

public NetflowVersion getNetflowVersion()

setNetflowVersion

public void setNetflowVersion(NetflowVersion netflowVersion)

getVlan
```
public String getVlan()
```

setVlan
```
public void setVlan(String vlan)
```

getNodeDst
```
public NodeDocument getNodeDst()
```

setNodeDst

public void setNodeDst(NodeDocument nodeDst)

getNodeExporter
```
public NodeDocument getNodeExporter()
```

setNodeExporter

public void setNodeExporter(NodeDocument nodeExporter)

getNodeSrc
```
public NodeDocument getNodeSrc()
```

setNodeSrc

public void setNodeSrc(NodeDocument nodeSrc)

from

public static FlowDocument from(Flow flow)

buildEnrichedFlow

public static EnrichedFlow buildEnrichedFlow(FlowDocument flowDocument)

Class FlowDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowDocument

FlowDocument

Method Detail

addHost

getFlow

setFlow

getTimestamp

setTimestamp

getClockCorrection

setClockCorrection

getVersion

setVersion

getHost

setHost

getHosts

setHosts

getLocation

setLocation

getApplication

setApplication

getBytes

setBytes

getConvoKey

setConvoKey

getDirection

setDirection

getDstAddr

setDstAddr

getDstAddrHostname

setDstAddrHostname

getDstAs

setDstAs

getDstLocality

setDstLocality

getDstMaskLen

setDstMaskLen

getDstPort

setDstPort

getEngineId

setEngineId

getEngineType

setEngineType

getFirstSwitched

setFirstSwitched

getFlowLocality

setFlowLocality

getFlowRecords

setFlowRecords

getFlowSeqNum

setFlowSeqNum

getInputSnmp

setInputSnmp

getIpProtocolVersion

setIpProtocolVersion

getLastSwitched

setLastSwitched

getNextHop

setNextHop

getNextHopHostname

setNextHopHostname

getOutputSnmp

setOutputSnmp

getPackets

setPackets

getProtocol

setProtocol

getSamplingAlgorithm

setSamplingAlgorithm

getSamplingInterval

setSamplingInterval

getSrcAddr

setSrcAddr

getSrcAddrHostname

setSrcAddrHostname

getSrcAs