Package org.opennms.netmgt.flows.persistence.model

Interface FlowDocumentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FlowDocument, FlowDocument.Builder
    public interface FlowDocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getTimestamp

        long getTimestamp()
         Flow timestamp in milliseconds.
        uint64 timestamp = 1;
        Returns:
        The timestamp.

      • hasNumBytes

        boolean hasNumBytes()
         Number of bytes transferred in the flow
        .google.protobuf.UInt64Value num_bytes = 2;
        Returns:
        Whether the numBytes field is set.

      • getNumBytes

        com.google.protobuf.UInt64Value getNumBytes()
         Number of bytes transferred in the flow
        .google.protobuf.UInt64Value num_bytes = 2;
        Returns:
        The numBytes.

      • getNumBytesOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getNumBytesOrBuilder()
         Number of bytes transferred in the flow
        .google.protobuf.UInt64Value num_bytes = 2;

      • getDirectionValue

        int getDirectionValue()
         Direction of the flow (egress vs ingress)
        .Direction direction = 3;
        Returns:
        The enum numeric value on the wire for direction.

      • getDirection

        Direction getDirection()
         Direction of the flow (egress vs ingress)
        .Direction direction = 3;
        Returns:
        The direction.

      • getDstAddress

        java.lang.String getDstAddress()
          Destination address.
        string dst_address = 4;
        Returns:
        The dstAddress.

      • getDstAddressBytes

        com.google.protobuf.ByteString getDstAddressBytes()
          Destination address.
        string dst_address = 4;
        Returns:
        The bytes for dstAddress.

      • getDstHostname

        java.lang.String getDstHostname()
         Destination address hostname.
        string dst_hostname = 5;
        Returns:
        The dstHostname.

      • getDstHostnameBytes

        com.google.protobuf.ByteString getDstHostnameBytes()
         Destination address hostname.
        string dst_hostname = 5;
        Returns:
        The bytes for dstHostname.

      • hasDstAs

        boolean hasDstAs()
         Destination autonomous system (AS).
        .google.protobuf.UInt64Value dst_as = 6;
        Returns:
        Whether the dstAs field is set.

      • getDstAs

        com.google.protobuf.UInt64Value getDstAs()
         Destination autonomous system (AS).
        .google.protobuf.UInt64Value dst_as = 6;
        Returns:
        The dstAs.

      • getDstAsOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getDstAsOrBuilder()
         Destination autonomous system (AS).
        .google.protobuf.UInt64Value dst_as = 6;

      • hasDstMaskLen

        boolean hasDstMaskLen()
         The number of contiguous bits in the source address subnet mask.
        .google.protobuf.UInt32Value dst_mask_len = 7;
        Returns:
        Whether the dstMaskLen field is set.

      • getDstMaskLen

        com.google.protobuf.UInt32Value getDstMaskLen()
         The number of contiguous bits in the source address subnet mask.
        .google.protobuf.UInt32Value dst_mask_len = 7;
        Returns:
        The dstMaskLen.

      • getDstMaskLenOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getDstMaskLenOrBuilder()
         The number of contiguous bits in the source address subnet mask.
        .google.protobuf.UInt32Value dst_mask_len = 7;

      • hasDstPort

        boolean hasDstPort()
         Destination port.
        .google.protobuf.UInt32Value dst_port = 8;
        Returns:
        Whether the dstPort field is set.

      • getDstPort

        com.google.protobuf.UInt32Value getDstPort()
         Destination port.
        .google.protobuf.UInt32Value dst_port = 8;
        Returns:
        The dstPort.

      • getDstPortOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getDstPortOrBuilder()
         Destination port.
        .google.protobuf.UInt32Value dst_port = 8;

      • hasEngineId

        boolean hasEngineId()
         Slot number of the flow-switching engine.
        .google.protobuf.UInt32Value engine_id = 9;
        Returns:
        Whether the engineId field is set.

      • getEngineId

        com.google.protobuf.UInt32Value getEngineId()
         Slot number of the flow-switching engine.
        .google.protobuf.UInt32Value engine_id = 9;
        Returns:
        The engineId.

      • getEngineIdOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getEngineIdOrBuilder()
         Slot number of the flow-switching engine.
        .google.protobuf.UInt32Value engine_id = 9;

      • hasEngineType

        boolean hasEngineType()
         Type of flow-switching engine.
        .google.protobuf.UInt32Value engine_type = 10;
        Returns:
        Whether the engineType field is set.

      • getEngineType

        com.google.protobuf.UInt32Value getEngineType()
         Type of flow-switching engine.
        .google.protobuf.UInt32Value engine_type = 10;
        Returns:
        The engineType.

      • getEngineTypeOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getEngineTypeOrBuilder()
         Type of flow-switching engine.
        .google.protobuf.UInt32Value engine_type = 10;

      • hasDeltaSwitched

        boolean hasDeltaSwitched()
         Unix timestamp in ms at which the previous exported packet-
        .google.protobuf.UInt64Value delta_switched = 11;
        Returns:
        Whether the deltaSwitched field is set.

      • getDeltaSwitched

        com.google.protobuf.UInt64Value getDeltaSwitched()
         Unix timestamp in ms at which the previous exported packet-
        .google.protobuf.UInt64Value delta_switched = 11;
        Returns:
        The deltaSwitched.

      • getDeltaSwitchedOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getDeltaSwitchedOrBuilder()
         Unix timestamp in ms at which the previous exported packet-
        .google.protobuf.UInt64Value delta_switched = 11;

      • hasFirstSwitched

        boolean hasFirstSwitched()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value first_switched = 12;
        Returns:
        Whether the firstSwitched field is set.

      • getFirstSwitched

        com.google.protobuf.UInt64Value getFirstSwitched()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value first_switched = 12;
        Returns:
        The firstSwitched.

      • getFirstSwitchedOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getFirstSwitchedOrBuilder()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value first_switched = 12;

      • hasLastSwitched

        boolean hasLastSwitched()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value last_switched = 13;
        Returns:
        Whether the lastSwitched field is set.

      • getLastSwitched

        com.google.protobuf.UInt64Value getLastSwitched()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value last_switched = 13;
        Returns:
        The lastSwitched.

      • getLastSwitchedOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getLastSwitchedOrBuilder()
         -associated with this flow was switched.
        .google.protobuf.UInt64Value last_switched = 13;

      • hasNumFlowRecords

        boolean hasNumFlowRecords()
         Number of flow records in the associated packet.
        .google.protobuf.UInt32Value num_flow_records = 14;
        Returns:
        Whether the numFlowRecords field is set.

      • getNumFlowRecords

        com.google.protobuf.UInt32Value getNumFlowRecords()
         Number of flow records in the associated packet.
        .google.protobuf.UInt32Value num_flow_records = 14;
        Returns:
        The numFlowRecords.

      • getNumFlowRecordsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getNumFlowRecordsOrBuilder()
         Number of flow records in the associated packet.
        .google.protobuf.UInt32Value num_flow_records = 14;

      • hasNumPackets

        boolean hasNumPackets()
         Number of packets in the flow.
        .google.protobuf.UInt64Value num_packets = 15;
        Returns:
        Whether the numPackets field is set.

      • getNumPackets

        com.google.protobuf.UInt64Value getNumPackets()
         Number of packets in the flow.
        .google.protobuf.UInt64Value num_packets = 15;
        Returns:
        The numPackets.

      • getNumPacketsOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getNumPacketsOrBuilder()
         Number of packets in the flow.
        .google.protobuf.UInt64Value num_packets = 15;

      • hasFlowSeqNum

        boolean hasFlowSeqNum()
         Flow packet sequence number.
        .google.protobuf.UInt64Value flow_seq_num = 16;
        Returns:
        Whether the flowSeqNum field is set.

      • getFlowSeqNum

        com.google.protobuf.UInt64Value getFlowSeqNum()
         Flow packet sequence number.
        .google.protobuf.UInt64Value flow_seq_num = 16;
        Returns:
        The flowSeqNum.

      • getFlowSeqNumOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getFlowSeqNumOrBuilder()
         Flow packet sequence number.
        .google.protobuf.UInt64Value flow_seq_num = 16;

      • hasInputSnmpIfindex

        boolean hasInputSnmpIfindex()
         Input SNMP ifIndex.
        .google.protobuf.UInt32Value input_snmp_ifindex = 17;
        Returns:
        Whether the inputSnmpIfindex field is set.

      • getInputSnmpIfindex

        com.google.protobuf.UInt32Value getInputSnmpIfindex()
         Input SNMP ifIndex.
        .google.protobuf.UInt32Value input_snmp_ifindex = 17;
        Returns:
        The inputSnmpIfindex.

      • getInputSnmpIfindexOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getInputSnmpIfindexOrBuilder()
         Input SNMP ifIndex.
        .google.protobuf.UInt32Value input_snmp_ifindex = 17;

      • hasOutputSnmpIfindex

        boolean hasOutputSnmpIfindex()
         Output SNMP ifIndex.
        .google.protobuf.UInt32Value output_snmp_ifindex = 18;
        Returns:
        Whether the outputSnmpIfindex field is set.

      • getOutputSnmpIfindex

        com.google.protobuf.UInt32Value getOutputSnmpIfindex()
         Output SNMP ifIndex.
        .google.protobuf.UInt32Value output_snmp_ifindex = 18;
        Returns:
        The outputSnmpIfindex.

      • getOutputSnmpIfindexOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getOutputSnmpIfindexOrBuilder()
         Output SNMP ifIndex.
        .google.protobuf.UInt32Value output_snmp_ifindex = 18;

      • hasIpProtocolVersion

        boolean hasIpProtocolVersion()
         IPv4 vs IPv6.
        .google.protobuf.UInt32Value ip_protocol_version = 19;
        Returns:
        Whether the ipProtocolVersion field is set.

      • getIpProtocolVersion

        com.google.protobuf.UInt32Value getIpProtocolVersion()
         IPv4 vs IPv6.
        .google.protobuf.UInt32Value ip_protocol_version = 19;
        Returns:
        The ipProtocolVersion.

      • getIpProtocolVersionOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getIpProtocolVersionOrBuilder()
         IPv4 vs IPv6.
        .google.protobuf.UInt32Value ip_protocol_version = 19;

      • getNextHopAddress

        java.lang.String getNextHopAddress()
         Next hop IpAddress.
        string next_hop_address = 20;
        Returns:
        The nextHopAddress.

      • getNextHopAddressBytes

        com.google.protobuf.ByteString getNextHopAddressBytes()
         Next hop IpAddress.
        string next_hop_address = 20;
        Returns:
        The bytes for nextHopAddress.

      • getNextHopHostname

        java.lang.String getNextHopHostname()
         Next hop hostname.
        string next_hop_hostname = 21;
        Returns:
        The nextHopHostname.

      • getNextHopHostnameBytes

        com.google.protobuf.ByteString getNextHopHostnameBytes()
         Next hop hostname.
        string next_hop_hostname = 21;
        Returns:
        The bytes for nextHopHostname.

      • hasProtocol

        boolean hasProtocol()
         IP protocol number i.e 6 for TCP, 17 for UDP
        .google.protobuf.UInt32Value protocol = 22;
        Returns:
        Whether the protocol field is set.

      • getProtocol

        com.google.protobuf.UInt32Value getProtocol()
         IP protocol number i.e 6 for TCP, 17 for UDP
        .google.protobuf.UInt32Value protocol = 22;
        Returns:
        The protocol.

      • getProtocolOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getProtocolOrBuilder()
         IP protocol number i.e 6 for TCP, 17 for UDP
        .google.protobuf.UInt32Value protocol = 22;

      • getSamplingAlgorithmValue

        int getSamplingAlgorithmValue()
         Sampling algorithm ID.
        .SamplingAlgorithm sampling_algorithm = 23;
        Returns:
        The enum numeric value on the wire for samplingAlgorithm.

      • getSamplingAlgorithm

        SamplingAlgorithm getSamplingAlgorithm()
         Sampling algorithm ID.
        .SamplingAlgorithm sampling_algorithm = 23;
        Returns:
        The samplingAlgorithm.

      • hasSamplingInterval

        boolean hasSamplingInterval()
         Sampling interval.
        .google.protobuf.DoubleValue sampling_interval = 24;
        Returns:
        Whether the samplingInterval field is set.

      • getSamplingInterval

        com.google.protobuf.DoubleValue getSamplingInterval()
         Sampling interval.
        .google.protobuf.DoubleValue sampling_interval = 24;
        Returns:
        The samplingInterval.

      • getSamplingIntervalOrBuilder

        com.google.protobuf.DoubleValueOrBuilder getSamplingIntervalOrBuilder()
         Sampling interval.
        .google.protobuf.DoubleValue sampling_interval = 24;

      • getSrcAddress

        java.lang.String getSrcAddress()
         Source address.
        string src_address = 26;
        Returns:
        The srcAddress.

      • getSrcAddressBytes

        com.google.protobuf.ByteString getSrcAddressBytes()
         Source address.
        string src_address = 26;
        Returns:
        The bytes for srcAddress.

      • getSrcHostname

        java.lang.String getSrcHostname()
         Source hostname.
        string src_hostname = 27;
        Returns:
        The srcHostname.

      • getSrcHostnameBytes

        com.google.protobuf.ByteString getSrcHostnameBytes()
         Source hostname.
        string src_hostname = 27;
        Returns:
        The bytes for srcHostname.

      • hasSrcAs

        boolean hasSrcAs()
         Source AS number.
        .google.protobuf.UInt64Value src_as = 28;
        Returns:
        Whether the srcAs field is set.

      • getSrcAs

        com.google.protobuf.UInt64Value getSrcAs()
         Source AS number.
        .google.protobuf.UInt64Value src_as = 28;
        Returns:
        The srcAs.

      • getSrcAsOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getSrcAsOrBuilder()
         Source AS number.
        .google.protobuf.UInt64Value src_as = 28;

      • hasSrcMaskLen

        boolean hasSrcMaskLen()
         The number of contiguous bits in the destination address subnet mask.
        .google.protobuf.UInt32Value src_mask_len = 29;
        Returns:
        Whether the srcMaskLen field is set.

      • getSrcMaskLen

        com.google.protobuf.UInt32Value getSrcMaskLen()
         The number of contiguous bits in the destination address subnet mask.
        .google.protobuf.UInt32Value src_mask_len = 29;
        Returns:
        The srcMaskLen.

      • getSrcMaskLenOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getSrcMaskLenOrBuilder()
         The number of contiguous bits in the destination address subnet mask.
        .google.protobuf.UInt32Value src_mask_len = 29;

      • hasSrcPort

        boolean hasSrcPort()
         Source port.
        .google.protobuf.UInt32Value src_port = 30;
        Returns:
        Whether the srcPort field is set.

      • getSrcPort

        com.google.protobuf.UInt32Value getSrcPort()
         Source port.
        .google.protobuf.UInt32Value src_port = 30;
        Returns:
        The srcPort.

      • getSrcPortOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getSrcPortOrBuilder()
         Source port.
        .google.protobuf.UInt32Value src_port = 30;

      • hasTcpFlags

        boolean hasTcpFlags()
         TCP Flags.
        .google.protobuf.UInt32Value tcp_flags = 31;
        Returns:
        Whether the tcpFlags field is set.

      • getTcpFlags

        com.google.protobuf.UInt32Value getTcpFlags()
         TCP Flags.
        .google.protobuf.UInt32Value tcp_flags = 31;
        Returns:
        The tcpFlags.

      • getTcpFlagsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getTcpFlagsOrBuilder()
         TCP Flags.
        .google.protobuf.UInt32Value tcp_flags = 31;

      • hasTos

        boolean hasTos()
         TOS
        .google.protobuf.UInt32Value tos = 32;
        Returns:
        Whether the tos field is set.

      • getTos

        com.google.protobuf.UInt32Value getTos()
         TOS
        .google.protobuf.UInt32Value tos = 32;
        Returns:
        The tos.

      • getTosOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getTosOrBuilder()
         TOS
        .google.protobuf.UInt32Value tos = 32;

      • getNetflowVersionValue

        int getNetflowVersionValue()
         Netflow version
        .NetflowVersion netflow_version = 33;
        Returns:
        The enum numeric value on the wire for netflowVersion.

      • getNetflowVersion

        NetflowVersion getNetflowVersion()
         Netflow version
        .NetflowVersion netflow_version = 33;
        Returns:
        The netflowVersion.

      • getVlan

        java.lang.String getVlan()
         VLAN ID.
        string vlan = 34;
        Returns:
        The vlan.

      • getVlanBytes

        com.google.protobuf.ByteString getVlanBytes()
         VLAN ID.
        string vlan = 34;
        Returns:
        The bytes for vlan.

      • hasSrcNode

        boolean hasSrcNode()
        .NodeInfo src_node = 35;
        Returns:
        Whether the srcNode field is set.

      • getSrcNode

        NodeInfo getSrcNode()
        .NodeInfo src_node = 35;
        Returns:
        The srcNode.

      • getSrcNodeOrBuilder

        NodeInfoOrBuilder getSrcNodeOrBuilder()
        .NodeInfo src_node = 35;

      • hasExporterNode

        boolean hasExporterNode()
        .NodeInfo exporter_node = 36;
        Returns:
        Whether the exporterNode field is set.

      • getExporterNode

        NodeInfo getExporterNode()
        .NodeInfo exporter_node = 36;
        Returns:
        The exporterNode.

      • getExporterNodeOrBuilder

        NodeInfoOrBuilder getExporterNodeOrBuilder()
        .NodeInfo exporter_node = 36;

      • hasDestNode

        boolean hasDestNode()
        .NodeInfo dest_node = 37;
        Returns:
        Whether the destNode field is set.

      • getDestNode

        NodeInfo getDestNode()
        .NodeInfo dest_node = 37;
        Returns:
        The destNode.

      • getDestNodeOrBuilder

        NodeInfoOrBuilder getDestNodeOrBuilder()
        .NodeInfo dest_node = 37;

      • getApplication

        java.lang.String getApplication()
        string application = 38;
        Returns:
        The application.

      • getApplicationBytes

        com.google.protobuf.ByteString getApplicationBytes()
        string application = 38;
        Returns:
        The bytes for application.

      • getHost

        java.lang.String getHost()
        string host = 39;
        Returns:
        The host.

      • getHostBytes

        com.google.protobuf.ByteString getHostBytes()
        string host = 39;
        Returns:
        The bytes for host.

      • getLocation

        java.lang.String getLocation()
        string location = 40;
        Returns:
        The location.

      • getLocationBytes

        com.google.protobuf.ByteString getLocationBytes()
        string location = 40;
        Returns:
        The bytes for location.

      • getSrcLocalityValue

        int getSrcLocalityValue()
        .Locality src_locality = 41;
        Returns:
        The enum numeric value on the wire for srcLocality.

      • getSrcLocality

        Locality getSrcLocality()
        .Locality src_locality = 41;
        Returns:
        The srcLocality.

      • getDstLocalityValue

        int getDstLocalityValue()
        .Locality dst_locality = 42;
        Returns:
        The enum numeric value on the wire for dstLocality.

      • getDstLocality

        Locality getDstLocality()
        .Locality dst_locality = 42;
        Returns:
        The dstLocality.

      • getFlowLocalityValue

        int getFlowLocalityValue()
        .Locality flow_locality = 43;
        Returns:
        The enum numeric value on the wire for flowLocality.

      • getFlowLocality

        Locality getFlowLocality()
        .Locality flow_locality = 43;
        Returns:
        The flowLocality.

      • getConvoKey

        java.lang.String getConvoKey()
        string convo_key = 44;
        Returns:
        The convoKey.

      • getConvoKeyBytes

        com.google.protobuf.ByteString getConvoKeyBytes()
        string convo_key = 44;
        Returns:
        The bytes for convoKey.

      • getClockCorrection

        long getClockCorrection()
         Applied clock correction im milliseconds.
        uint64 clock_correction = 45;
        Returns:
        The clockCorrection.

      • hasDscp

        boolean hasDscp()
         DSCP; upper 6 bits of TOS
        .google.protobuf.UInt32Value dscp = 46;
        Returns:
        Whether the dscp field is set.

      • getDscp

        com.google.protobuf.UInt32Value getDscp()
         DSCP; upper 6 bits of TOS
        .google.protobuf.UInt32Value dscp = 46;
        Returns:
        The dscp.

      • getDscpOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getDscpOrBuilder()
         DSCP; upper 6 bits of TOS
        .google.protobuf.UInt32Value dscp = 46;

      • hasEcn

        boolean hasEcn()
         ECN; lower 2 bits of TOS
        .google.protobuf.UInt32Value ecn = 47;
        Returns:
        Whether the ecn field is set.

      • getEcn

        com.google.protobuf.UInt32Value getEcn()
         ECN; lower 2 bits of TOS
        .google.protobuf.UInt32Value ecn = 47;
        Returns:
        The ecn.

      • getEcnOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getEcnOrBuilder()
         ECN; lower 2 bits of TOS
        .google.protobuf.UInt32Value ecn = 47;