IpfixDfwTemplateParameters (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.IpfixDfwTemplateParameters

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IpfixDfwTemplateParameters
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This entity represents the flow parameters which are exported.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IpfixDfwTemplateParameters.Builder
Builder class for IpfixDfwTemplateParameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IpfixDfwTemplateParameters.Builder` Builder class for `IpfixDfwTemplateParameters`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`IpfixDfwTemplateParameters()` Default constructor.
`protected`	`IpfixDfwTemplateParameters(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static IpfixDfwTemplateParameters`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static IpfixDfwTemplateParameters`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getDestinationAddress()` The destination IP address of a monitored network flow.
`java.lang.Boolean`	`getDestinationTransportPort()` The destination transport port of a monitored network flow.
`java.lang.Boolean`	`getFirewallEvent()` Five valid values are allowed: 1.
`java.lang.Boolean`	`getFlowDirection()` Two valid values are allowed: 1.
`java.lang.Boolean`	`getFlowEnd()` The absolute timestamp (seconds) of the last packet of this flow.
`java.lang.Boolean`	`getFlowStart()` The absolute timestamp (seconds) of the first packet of this flow.
`java.lang.Boolean`	`getIcmpCode()` Code of the IPv4 ICMP message.
`java.lang.Boolean`	`getOctetDeltaCount()` The number of octets since the previous report (if any) in incoming packets for this flow at the observation point.
`java.lang.Boolean`	`getPacketDeltaCount()` The number of incoming packets since the previous report (if any) for this flow at the observation point.
`java.lang.Boolean`	`getProtocolIdentifier()` The value of the protocol number in the IP packet header.
`java.lang.Boolean`	`getRuleId()` Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule.
`java.lang.Boolean`	`getSourceAddress()` The source IP address of a monitored network flow.
`java.lang.Boolean`	`getSourceIcmpType()` Type of the IPv4 ICMP message.
`java.lang.Boolean`	`getSourceTransportPort()` The source transport port of a monitored network flow.
`java.lang.Boolean`	`getVifUuid()` VIF UUID - enterprise specific Information Element that uniquely identifies VIF.
`int`	`hashCode()`
`void`	`setDestinationAddress(java.lang.Boolean destinationAddress)` The destination IP address of a monitored network flow.
`void`	`setDestinationTransportPort(java.lang.Boolean destinationTransportPort)` The destination transport port of a monitored network flow.
`void`	`setFirewallEvent(java.lang.Boolean firewallEvent)` Five valid values are allowed: 1.
`void`	`setFlowDirection(java.lang.Boolean flowDirection)` Two valid values are allowed: 1.
`void`	`setFlowEnd(java.lang.Boolean flowEnd)` The absolute timestamp (seconds) of the last packet of this flow.
`void`	`setFlowStart(java.lang.Boolean flowStart)` The absolute timestamp (seconds) of the first packet of this flow.
`void`	`setIcmpCode(java.lang.Boolean icmpCode)` Code of the IPv4 ICMP message.
`void`	`setOctetDeltaCount(java.lang.Boolean octetDeltaCount)` The number of octets since the previous report (if any) in incoming packets for this flow at the observation point.
`void`	`setPacketDeltaCount(java.lang.Boolean packetDeltaCount)` The number of incoming packets since the previous report (if any) for this flow at the observation point.
`void`	`setProtocolIdentifier(java.lang.Boolean protocolIdentifier)` The value of the protocol number in the IP packet header.
`void`	`setRuleId(java.lang.Boolean ruleId)` Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule.
`void`	`setSourceAddress(java.lang.Boolean sourceAddress)` The source IP address of a monitored network flow.
`void`	`setSourceIcmpType(java.lang.Boolean sourceIcmpType)` Type of the IPv4 ICMP message.
`void`	`setSourceTransportPort(java.lang.Boolean sourceTransportPort)` The source transport port of a monitored network flow.
`void`	`setVifUuid(java.lang.Boolean vifUuid)` VIF UUID - enterprise specific Information Element that uniquely identifies VIF.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IpfixDfwTemplateParameters
```
public IpfixDfwTemplateParameters()
```
    Default constructor.
  - IpfixDfwTemplateParameters
```
protected IpfixDfwTemplateParameters(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getDestinationAddress
```
public java.lang.Boolean getDestinationAddress()
```
    The destination IP address of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDestinationAddress
```
public void setDestinationAddress(java.lang.Boolean destinationAddress)
```
    The destination IP address of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    destinationAddress - New value for the property.
  - getDestinationTransportPort
```
public java.lang.Boolean getDestinationTransportPort()
```
    The destination transport port of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDestinationTransportPort
```
public void setDestinationTransportPort(java.lang.Boolean destinationTransportPort)
```
    The destination transport port of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    destinationTransportPort - New value for the property.
  - getFirewallEvent
```
public java.lang.Boolean getFirewallEvent()
```
    Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. Flow Denied. 4. Flow Alert (not used in DropKick implementation). 5. Flow Update. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFirewallEvent
```
public void setFirewallEvent(java.lang.Boolean firewallEvent)
```
    Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. Flow Denied. 4. Flow Alert (not used in DropKick implementation). 5. Flow Update. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    firewallEvent - New value for the property.
  - getFlowDirection
```
public java.lang.Boolean getFlowDirection()
```
    Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: egress flow from VM. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFlowDirection
```
public void setFlowDirection(java.lang.Boolean flowDirection)
```
    Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: egress flow from VM. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    flowDirection - New value for the property.
  - getFlowEnd
```
public java.lang.Boolean getFlowEnd()
```
    The absolute timestamp (seconds) of the last packet of this flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFlowEnd
```
public void setFlowEnd(java.lang.Boolean flowEnd)
```
    The absolute timestamp (seconds) of the last packet of this flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    flowEnd - New value for the property.
  - getFlowStart
```
public java.lang.Boolean getFlowStart()
```
    The absolute timestamp (seconds) of the first packet of this flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFlowStart
```
public void setFlowStart(java.lang.Boolean flowStart)
```
    The absolute timestamp (seconds) of the first packet of this flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    flowStart - New value for the property.
  - getIcmpCode
```
public java.lang.Boolean getIcmpCode()
```
    Code of the IPv4 ICMP message. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setIcmpCode
```
public void setIcmpCode(java.lang.Boolean icmpCode)
```
    Code of the IPv4 ICMP message. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    icmpCode - New value for the property.
  - getOctetDeltaCount
```
public java.lang.Boolean getOctetDeltaCount()
```
    The number of octets since the previous report (if any) in incoming packets for this flow at the observation point. The number of octets include IP header(s) and payload. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setOctetDeltaCount
```
public void setOctetDeltaCount(java.lang.Boolean octetDeltaCount)
```
    The number of octets since the previous report (if any) in incoming packets for this flow at the observation point. The number of octets include IP header(s) and payload. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    octetDeltaCount - New value for the property.
  - getPacketDeltaCount
```
public java.lang.Boolean getPacketDeltaCount()
```
    The number of incoming packets since the previous report (if any) for this flow at the observation point. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setPacketDeltaCount
```
public void setPacketDeltaCount(java.lang.Boolean packetDeltaCount)
```
    The number of incoming packets since the previous report (if any) for this flow at the observation point. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    packetDeltaCount - New value for the property.
  - getProtocolIdentifier
```
public java.lang.Boolean getProtocolIdentifier()
```
    The value of the protocol number in the IP packet header. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setProtocolIdentifier
```
public void setProtocolIdentifier(java.lang.Boolean protocolIdentifier)
```
    The value of the protocol number in the IP packet header. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    protocolIdentifier - New value for the property.
  - getRuleId
```
public java.lang.Boolean getRuleId()
```
    Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRuleId
```
public void setRuleId(java.lang.Boolean ruleId)
```
    Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    ruleId - New value for the property.
  - getSourceAddress
```
public java.lang.Boolean getSourceAddress()
```
    The source IP address of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSourceAddress
```
public void setSourceAddress(java.lang.Boolean sourceAddress)
```
    The source IP address of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    sourceAddress - New value for the property.
  - getSourceIcmpType
```
public java.lang.Boolean getSourceIcmpType()
```
    Type of the IPv4 ICMP message. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSourceIcmpType
```
public void setSourceIcmpType(java.lang.Boolean sourceIcmpType)
```
    Type of the IPv4 ICMP message. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    sourceIcmpType - New value for the property.
  - getSourceTransportPort
```
public java.lang.Boolean getSourceTransportPort()
```
    The source transport port of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSourceTransportPort
```
public void setSourceTransportPort(java.lang.Boolean sourceTransportPort)
```
    The source transport port of a monitored network flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    sourceTransportPort - New value for the property.
  - getVifUuid
```
public java.lang.Boolean getVifUuid()
```
    VIF UUID - enterprise specific Information Element that uniquely identifies VIF. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setVifUuid
```
public void setVifUuid(java.lang.Boolean vifUuid)
```
    VIF UUID - enterprise specific Information Element that uniquely identifies VIF. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    vifUuid - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static IpfixDfwTemplateParameters _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static IpfixDfwTemplateParameters _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IpfixDfwTemplateParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

IpfixDfwTemplateParameters

IpfixDfwTemplateParameters

Method Detail

getDestinationAddress

setDestinationAddress

getDestinationTransportPort

setDestinationTransportPort

getFirewallEvent

setFirewallEvent

getFlowDirection

setFlowDirection

getFlowEnd

setFlowEnd

getFlowStart

setFlowStart

getIcmpCode

setIcmpCode

getOctetDeltaCount

setOctetDeltaCount

getPacketDeltaCount

setPacketDeltaCount

getProtocolIdentifier

setProtocolIdentifier

getRuleId

setRuleId

getSourceAddress

setSourceAddress

getSourceIcmpType

setSourceIcmpType

getSourceTransportPort

setSourceTransportPort

getVifUuid

setVifUuid

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2