LBNodeUsageSummary (Java SDK for NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LBNodeUsageSummary
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The load balancer node usage summary for all nodes from specific enforcement point. Only edge node is supported. The summary contains all edge nodes which are configured in edge clusters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LBNodeUsageSummary.Builder
Builder class for LBNodeUsageSummary.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`SEVERITY_GREEN`
`static java.lang.String`	`SEVERITY_ORANGE`
`static java.lang.String`	`SEVERITY_RED`

Constructor Summary

Constructors
Modifier Constructor and Description

LBNodeUsageSummary()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`LBNodeUsageSummary()` Default constructor.
`protected`	`LBNodeUsageSummary(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 LBNodeUsageSummary`	`_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 LBNodeUsageSummary`	`_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)`
`PolicyRuntimeAlarm`	`getAlarm()`
`java.lang.Long`	`getCurrentLoadBalancerCredits()` Current load balancer credits in use for all nodes.
`java.lang.Long`	`getCurrentPoolMemberCount()` The overall count of pool members configured on all nodes.
`java.lang.String`	`getEnforcementPointPath()` Policy Path referencing the enforcement point where the info is fetched.
`java.lang.Long`	`getLoadBalancerCreditCapacity()` The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes.
`java.util.List<LBNodeCountPerSeverity>`	`getNodeCounts()` The property identifies array of node count for each severity.
`java.util.List<com.vmware.vapi.bindings.Structure>`	`getNodeUsages()` The property identifies all LB node usages.
`java.lang.Long`	`getPoolMemberCapacity()` Pool member capacity means maximum number of pool members which can be configured on all nodes.
`java.lang.String`	`getSeverity()` Possible values are: `SEVERITY_GREEN` `SEVERITY_ORANGE` `SEVERITY_RED` The severity calculation is based on overall credit usage percentage of load balancer for all nodes.
`java.lang.Double`	`getUsagePercentage()` The overall usage percentage of all nodes for load balancer.
`int`	`hashCode()`
`void`	`setAlarm(PolicyRuntimeAlarm alarm)`
`void`	`setCurrentLoadBalancerCredits(java.lang.Long currentLoadBalancerCredits)` Current load balancer credits in use for all nodes.
`void`	`setCurrentPoolMemberCount(java.lang.Long currentPoolMemberCount)` The overall count of pool members configured on all nodes.
`void`	`setEnforcementPointPath(java.lang.String enforcementPointPath)` Policy Path referencing the enforcement point where the info is fetched.
`void`	`setLoadBalancerCreditCapacity(java.lang.Long loadBalancerCreditCapacity)` The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes.
`void`	`setNodeCounts(java.util.List<LBNodeCountPerSeverity> nodeCounts)` The property identifies array of node count for each severity.
`void`	`setNodeUsages(java.util.List<com.vmware.vapi.bindings.Structure> nodeUsages)` The property identifies all LB node usages.
`void`	`setPoolMemberCapacity(java.lang.Long poolMemberCapacity)` Pool member capacity means maximum number of pool members which can be configured on all nodes.
`void`	`setSeverity(java.lang.String severity)` Possible values are: `SEVERITY_GREEN` `SEVERITY_ORANGE` `SEVERITY_RED` The severity calculation is based on overall credit usage percentage of load balancer for all nodes.
`void`	`setUsagePercentage(java.lang.Double usagePercentage)` The overall usage percentage of all nodes for load balancer.
`java.lang.String`	`toString()`

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

- Field Detail
  - SEVERITY_GREEN
```
public static final java.lang.String SEVERITY_GREEN
```
    See Also:
    
    Constant Field Values
  - SEVERITY_ORANGE
```
public static final java.lang.String SEVERITY_ORANGE
```
    See Also:
    
    Constant Field Values
  - SEVERITY_RED
```
public static final java.lang.String SEVERITY_RED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LBNodeUsageSummary
```
public LBNodeUsageSummary()
```
    Default constructor.
  - LBNodeUsageSummary
```
protected LBNodeUsageSummary(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAlarm
```
public PolicyRuntimeAlarm getAlarm()
```
    Returns:
    
    The current value of the property.
  - setAlarm
```
public void setAlarm(PolicyRuntimeAlarm alarm)
```
    Parameters:
    
    alarm - New value for the property.
  - getEnforcementPointPath
```
public java.lang.String getEnforcementPointPath()
```
    Policy Path referencing the enforcement point where the info is fetched. 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.
  - setEnforcementPointPath
```
public void setEnforcementPointPath(java.lang.String enforcementPointPath)
```
    Policy Path referencing the enforcement point where the info is fetched. 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:
    
    enforcementPointPath - New value for the property.
  - getCurrentLoadBalancerCredits
```
public java.lang.Long getCurrentLoadBalancerCredits()
```
    Current load balancer credits in use for all nodes. For example, configuring a medium load balancer on a node consumes 10 credits. If there are 2 medium instances configured, the current load balancer credit number is 2 * 10 = 20. 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.
  - setCurrentLoadBalancerCredits
```
public void setCurrentLoadBalancerCredits(java.lang.Long currentLoadBalancerCredits)
```
    Current load balancer credits in use for all nodes. For example, configuring a medium load balancer on a node consumes 10 credits. If there are 2 medium instances configured, the current load balancer credit number is 2 * 10 = 20. 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:
    
    currentLoadBalancerCredits - New value for the property.
  - getCurrentPoolMemberCount
```
public java.lang.Long getCurrentPoolMemberCount()
```
    The overall count of pool members configured on all nodes. 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.
  - setCurrentPoolMemberCount
```
public void setCurrentPoolMemberCount(java.lang.Long currentPoolMemberCount)
```
    The overall count of pool members configured on all nodes. 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:
    
    currentPoolMemberCount - New value for the property.
  - getLoadBalancerCreditCapacity
```
public java.lang.Long getLoadBalancerCreditCapacity()
```
    The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes. 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.
  - setLoadBalancerCreditCapacity
```
public void setLoadBalancerCreditCapacity(java.lang.Long loadBalancerCreditCapacity)
```
    The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes. 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:
    
    loadBalancerCreditCapacity - New value for the property.
  - getNodeCounts
```
public java.util.List<LBNodeCountPerSeverity> getNodeCounts()
```
    The property identifies array of node count for each severity. 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.
  - setNodeCounts
```
public void setNodeCounts(java.util.List<LBNodeCountPerSeverity> nodeCounts)
```
    The property identifies array of node count for each severity. 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:
    
    nodeCounts - New value for the property.
  - getNodeUsages
```
public java.util.List<com.vmware.vapi.bindings.Structure> getNodeUsages()
```
    The property identifies all LB node usages. By default, it is not included in response. It exists when parameter ?include_usages=true. 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. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LBNodeUsage. When methods return a value of this class as a return value, the property will contain all the properties defined in LBNodeUsage.
  - setNodeUsages
```
public void setNodeUsages(java.util.List<com.vmware.vapi.bindings.Structure> nodeUsages)
```
    The property identifies all LB node usages. By default, it is not included in response. It exists when parameter ?include_usages=true. 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:
    
    nodeUsages - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LBNodeUsage. When methods return a value of this class as a return value, the property will contain all the properties defined in LBNodeUsage.
  - getPoolMemberCapacity
```
public java.lang.Long getPoolMemberCapacity()
```
    Pool member capacity means maximum number of pool members which can be configured on all nodes. 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.
  - setPoolMemberCapacity
```
public void setPoolMemberCapacity(java.lang.Long poolMemberCapacity)
```
    Pool member capacity means maximum number of pool members which can be configured on all nodes. 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:
    
    poolMemberCapacity - New value for the property.
  - getSeverity
```
public java.lang.String getSeverity()
```
    Possible values are:
    The severity calculation is based on overall credit usage percentage of load balancer for all nodes. 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.
  - setSeverity
```
public void setSeverity(java.lang.String severity)
```
    Possible values are:
    The severity calculation is based on overall credit usage percentage of load balancer for all nodes. 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:
    
    severity - New value for the property.
  - getUsagePercentage
```
public java.lang.Double getUsagePercentage()
```
    The overall usage percentage of all nodes for load balancer. The value is the larger value between overall pool member usage percentage and overall load balancer credit usage percentage. 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.
  - setUsagePercentage
```
public void setUsagePercentage(java.lang.Double usagePercentage)
```
    The overall usage percentage of all nodes for load balancer. The value is the larger value between overall pool member usage percentage and overall load balancer credit usage percentage. 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:
    
    usagePercentage - 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 LBNodeUsageSummary _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 LBNodeUsageSummary _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LBNodeUsageSummary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEVERITY_GREEN

SEVERITY_ORANGE

SEVERITY_RED

__dynamicStructureFields

Constructor Detail

LBNodeUsageSummary

LBNodeUsageSummary

Method Detail

getAlarm

setAlarm

getEnforcementPointPath

setEnforcementPointPath

getCurrentLoadBalancerCredits

setCurrentLoadBalancerCredits

getCurrentPoolMemberCount

setCurrentPoolMemberCount

getLoadBalancerCreditCapacity

setLoadBalancerCreditCapacity

getNodeCounts

setNodeCounts

getNodeUsages

setNodeUsages

getPoolMemberCapacity

setPoolMemberCapacity

getSeverity

setSeverity

getUsagePercentage

setUsagePercentage

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2