ForwardingRuleStats (Java SDK for NSX Policy API 4.1.1.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.ForwardingRuleStats

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ForwardingRuleStats
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
FP Rule Statistics.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ForwardingRuleStats.Builder
Builder class for ForwardingRuleStats.

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

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

ForwardingRuleStats()
Default constructor.

protected ForwardingRuleStats(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ForwardingRuleStats()` Default constructor.
`protected`	`ForwardingRuleStats(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 ForwardingRuleStats`	`_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 ForwardingRuleStats`	`_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.Long`	`getByteCount()` Aggregated number of bytes processed by the rule.
`java.lang.Long`	`getHitCount()` Aggregated number of hits received by the rule.
`java.lang.String`	`getInternalRuleId()` Realized id of the rule on NSX MP.
`java.lang.Long`	`getL7AcceptCount()` Aggregated number of L7 Profile Accepted counters received by the rule.
`java.lang.Long`	`getL7RejectCount()` Aggregated number of L7 Profile Rejected counters received by the rule.
`java.lang.Long`	`getL7RejectWithResponseCount()` Aggregated number of L7 Profile Rejected with Response counters received by the rule.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getLrPath()` Path of the LR on which the section is applied in case of Edge FW.
`java.lang.Long`	`getMaxPopularityIndex()` Maximum value of popularity index of all rules of the type.
`java.lang.Long`	`getMaxSessionCount()` Maximum value of sessions count of all rules of the type.
`java.lang.Long`	`getPacketCount()` Aggregated number of packets processed by the rule.
`java.lang.Long`	`getPopularityIndex()` This is calculated by sessions count divided by age of the rule.
`java.lang.String`	`getRule()` Path of the rule.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.Long`	`getSessionCount()` Aggregated number of sessions processed by the rule.
`java.lang.Long`	`getTotalSessionCount()` Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics.
`int`	`hashCode()`
`void`	`setByteCount(java.lang.Long byteCount)` Aggregated number of bytes processed by the rule.
`void`	`setHitCount(java.lang.Long hitCount)` Aggregated number of hits received by the rule.
`void`	`setInternalRuleId(java.lang.String internalRuleId)` Realized id of the rule on NSX MP.
`void`	`setL7AcceptCount(java.lang.Long l7AcceptCount)` Aggregated number of L7 Profile Accepted counters received by the rule.
`void`	`setL7RejectCount(java.lang.Long l7RejectCount)` Aggregated number of L7 Profile Rejected counters received by the rule.
`void`	`setL7RejectWithResponseCount(java.lang.Long l7RejectWithResponseCount)` Aggregated number of L7 Profile Rejected with Response counters received by the rule.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setLrPath(java.lang.String lrPath)` Path of the LR on which the section is applied in case of Edge FW.
`void`	`setMaxPopularityIndex(java.lang.Long maxPopularityIndex)` Maximum value of popularity index of all rules of the type.
`void`	`setMaxSessionCount(java.lang.Long maxSessionCount)` Maximum value of sessions count of all rules of the type.
`void`	`setPacketCount(java.lang.Long packetCount)` Aggregated number of packets processed by the rule.
`void`	`setPopularityIndex(java.lang.Long popularityIndex)` This is calculated by sessions count divided by age of the rule.
`void`	`setRule(java.lang.String rule)` Path of the rule.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSessionCount(java.lang.Long sessionCount)` Aggregated number of sessions processed by the rule.
`void`	`setTotalSessionCount(java.lang.Long totalSessionCount)` Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics.
`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
  - ForwardingRuleStats
```
public ForwardingRuleStats()
```
    Default constructor.
  - ForwardingRuleStats
```
protected ForwardingRuleStats(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource 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.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource 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:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getByteCount
```
public java.lang.Long getByteCount()
```
    Aggregated number of bytes processed by the rule. format: int64 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.
  - setByteCount
```
public void setByteCount(java.lang.Long byteCount)
```
    Aggregated number of bytes processed by the rule. format: int64 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:
    
    byteCount - New value for the property.
  - getHitCount
```
public java.lang.Long getHitCount()
```
    Aggregated number of hits received by the rule. format: int64 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.
  - setHitCount
```
public void setHitCount(java.lang.Long hitCount)
```
    Aggregated number of hits received by the rule. format: int64 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:
    
    hitCount - New value for the property.
  - getInternalRuleId
```
public java.lang.String getInternalRuleId()
```
    Realized id of the rule on NSX MP. Policy Manager can create more than one rule per policy rule, in which case this identifier helps to distinguish between the multple rules created. 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.
  - setInternalRuleId
```
public void setInternalRuleId(java.lang.String internalRuleId)
```
    Realized id of the rule on NSX MP. Policy Manager can create more than one rule per policy rule, in which case this identifier helps to distinguish between the multple rules created. 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:
    
    internalRuleId - New value for the property.
  - getL7AcceptCount
```
public java.lang.Long getL7AcceptCount()
```
    Aggregated number of L7 Profile Accepted counters received by the rule. format: int64 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.
  - setL7AcceptCount
```
public void setL7AcceptCount(java.lang.Long l7AcceptCount)
```
    Aggregated number of L7 Profile Accepted counters received by the rule. format: int64 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:
    
    l7AcceptCount - New value for the property.
  - getL7RejectCount
```
public java.lang.Long getL7RejectCount()
```
    Aggregated number of L7 Profile Rejected counters received by the rule. format: int64 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.
  - setL7RejectCount
```
public void setL7RejectCount(java.lang.Long l7RejectCount)
```
    Aggregated number of L7 Profile Rejected counters received by the rule. format: int64 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:
    
    l7RejectCount - New value for the property.
  - getL7RejectWithResponseCount
```
public java.lang.Long getL7RejectWithResponseCount()
```
    Aggregated number of L7 Profile Rejected with Response counters received by the rule. format: int64 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.
  - setL7RejectWithResponseCount
```
public void setL7RejectWithResponseCount(java.lang.Long l7RejectWithResponseCount)
```
    Aggregated number of L7 Profile Rejected with Response counters received by the rule. format: int64 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:
    
    l7RejectWithResponseCount - New value for the property.
  - getLrPath
```
public java.lang.String getLrPath()
```
    Path of the LR on which the section is applied in case of Edge FW. 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.
  - setLrPath
```
public void setLrPath(java.lang.String lrPath)
```
    Path of the LR on which the section is applied in case of Edge FW. 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:
    
    lrPath - New value for the property.
  - getMaxPopularityIndex
```
public java.lang.Long getMaxPopularityIndex()
```
    Maximum value of popularity index of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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.
  - setMaxPopularityIndex
```
public void setMaxPopularityIndex(java.lang.Long maxPopularityIndex)
```
    Maximum value of popularity index of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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:
    
    maxPopularityIndex - New value for the property.
  - getMaxSessionCount
```
public java.lang.Long getMaxSessionCount()
```
    Maximum value of sessions count of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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.
  - setMaxSessionCount
```
public void setMaxSessionCount(java.lang.Long maxSessionCount)
```
    Maximum value of sessions count of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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:
    
    maxSessionCount - New value for the property.
  - getPacketCount
```
public java.lang.Long getPacketCount()
```
    Aggregated number of packets processed by the rule. format: int64 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.
  - setPacketCount
```
public void setPacketCount(java.lang.Long packetCount)
```
    Aggregated number of packets processed by the rule. format: int64 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:
    
    packetCount - New value for the property.
  - getPopularityIndex
```
public java.lang.Long getPopularityIndex()
```
    This is calculated by sessions count divided by age of the rule. format: int64 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.
  - setPopularityIndex
```
public void setPopularityIndex(java.lang.Long popularityIndex)
```
    This is calculated by sessions count divided by age of the rule. format: int64 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:
    
    popularityIndex - New value for the property.
  - getRule
```
public java.lang.String getRule()
```
    Path of the 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.
  - setRule
```
public void setRule(java.lang.String rule)
```
    Path of the 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:
    
    rule - New value for the property.
  - getSessionCount
```
public java.lang.Long getSessionCount()
```
    Aggregated number of sessions processed by the rule. format: int64 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.
  - setSessionCount
```
public void setSessionCount(java.lang.Long sessionCount)
```
    Aggregated number of sessions processed by the rule. format: int64 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:
    
    sessionCount - New value for the property.
  - getTotalSessionCount
```
public java.lang.Long getTotalSessionCount()
```
    Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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.
  - setTotalSessionCount
```
public void setTotalSessionCount(java.lang.Long totalSessionCount)
```
    Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 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:
    
    totalSessionCount - 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 ForwardingRuleStats _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 ForwardingRuleStats _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ForwardingRuleStats

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ForwardingRuleStats

ForwardingRuleStats

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getByteCount

setByteCount

getHitCount

setHitCount

getInternalRuleId

setInternalRuleId

getL7AcceptCount

setL7AcceptCount

getL7RejectCount

setL7RejectCount

getL7RejectWithResponseCount

setL7RejectWithResponseCount

getLrPath

setLrPath

getMaxPopularityIndex

setMaxPopularityIndex

getMaxSessionCount

setMaxSessionCount

getPacketCount

setPacketCount

getPopularityIndex

setPopularityIndex

getRule

setRule

getSessionCount

setSessionCount

getTotalSessionCount

setTotalSessionCount

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2