LBServiceUsageSummary (Java SDK for NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LBServiceUsageSummary
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Describes usage summary of virtual servers, pools and pool members for all load balancer services.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LBServiceUsageSummary.Builder
Builder class for LBServiceUsageSummary.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`POOL_MEMBER_SEVERITY_GREEN`
`static java.lang.String`	`POOL_MEMBER_SEVERITY_ORANGE`
`static java.lang.String`	`POOL_MEMBER_SEVERITY_RED`
`static java.lang.String`	`POOL_SEVERITY_GREEN`
`static java.lang.String`	`POOL_SEVERITY_ORANGE`
`static java.lang.String`	`POOL_SEVERITY_RED`
`static java.lang.String`	`VIRTUAL_SERVER_SEVERITY_GREEN`
`static java.lang.String`	`VIRTUAL_SERVER_SEVERITY_ORANGE`
`static java.lang.String`	`VIRTUAL_SERVER_SEVERITY_RED`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LBServiceUsageSummary()` Default constructor.
`protected`	`LBServiceUsageSummary(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 LBServiceUsageSummary`	`_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 LBServiceUsageSummary`	`_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`	`getCurrentPoolCount()` The current count of pools configured for all load balancer services.
`java.lang.Long`	`getCurrentPoolMemberCount()` The current count of pool members configured for all load balancer services.
`java.lang.Long`	`getCurrentVirtualServerCount()` The current count of virtual servers configured for all load balancer services.
`java.lang.Long`	`getPoolCapacity()` Pool capacity means maximum number of pools which can be configured for all load balancer services.
`java.lang.Long`	`getPoolMemberCapacity()` Pool capacity means maximum number of pool members which can be configured for all load balancer services.
`java.lang.String`	`getPoolMemberSeverity()` Possible values are: `POOL_MEMBER_SEVERITY_GREEN` `POOL_MEMBER_SEVERITY_ORANGE` `POOL_MEMBER_SEVERITY_RED` The severity calculation is based on the overall usage percentage of pool members for all load balancer services.
`java.lang.Double`	`getPoolMemberUsagePercentage()` Overall pool member usage percentage for all load balancer services.
`java.lang.String`	`getPoolSeverity()` Possible values are: `POOL_SEVERITY_GREEN` `POOL_SEVERITY_ORANGE` `POOL_SEVERITY_RED` The severity calculation is based on the overall usage percentage of pools for all load balancer services.
`java.lang.Double`	`getPoolUsagePercentage()` Overall pool usage percentage for all load balancer services.
`java.util.List<LBServiceCountPerSeverity>`	`getServiceCounts()` The service count for each load balancer usage severity.
`java.util.List<LBServiceUsage>`	`getServiceUsages()` The property identifies all lb service usages.
`java.lang.Long`	`getVirtualServerCapacity()` Virtual server capacity means maximum number of virtual servers which can be configured for all load balancer services.
`java.lang.String`	`getVirtualServerSeverity()` Possible values are: `VIRTUAL_SERVER_SEVERITY_GREEN` `VIRTUAL_SERVER_SEVERITY_ORANGE` `VIRTUAL_SERVER_SEVERITY_RED` The severity calculation is based on the overall usage percentage of virtual servers for all load balancer services.
`java.lang.Double`	`getVirtualServerUsagePercentage()` Overall virtual server usage percentage for all load balancer services.
`int`	`hashCode()`
`void`	`setCurrentPoolCount(java.lang.Long currentPoolCount)` The current count of pools configured for all load balancer services.
`void`	`setCurrentPoolMemberCount(java.lang.Long currentPoolMemberCount)` The current count of pool members configured for all load balancer services.
`void`	`setCurrentVirtualServerCount(java.lang.Long currentVirtualServerCount)` The current count of virtual servers configured for all load balancer services.
`void`	`setPoolCapacity(java.lang.Long poolCapacity)` Pool capacity means maximum number of pools which can be configured for all load balancer services.
`void`	`setPoolMemberCapacity(java.lang.Long poolMemberCapacity)` Pool capacity means maximum number of pool members which can be configured for all load balancer services.
`void`	`setPoolMemberSeverity(java.lang.String poolMemberSeverity)` Possible values are: `POOL_MEMBER_SEVERITY_GREEN` `POOL_MEMBER_SEVERITY_ORANGE` `POOL_MEMBER_SEVERITY_RED` The severity calculation is based on the overall usage percentage of pool members for all load balancer services.
`void`	`setPoolMemberUsagePercentage(java.lang.Double poolMemberUsagePercentage)` Overall pool member usage percentage for all load balancer services.
`void`	`setPoolSeverity(java.lang.String poolSeverity)` Possible values are: `POOL_SEVERITY_GREEN` `POOL_SEVERITY_ORANGE` `POOL_SEVERITY_RED` The severity calculation is based on the overall usage percentage of pools for all load balancer services.
`void`	`setPoolUsagePercentage(java.lang.Double poolUsagePercentage)` Overall pool usage percentage for all load balancer services.
`void`	`setServiceCounts(java.util.List<LBServiceCountPerSeverity> serviceCounts)` The service count for each load balancer usage severity.
`void`	`setServiceUsages(java.util.List<LBServiceUsage> serviceUsages)` The property identifies all lb service usages.
`void`	`setVirtualServerCapacity(java.lang.Long virtualServerCapacity)` Virtual server capacity means maximum number of virtual servers which can be configured for all load balancer services.
`void`	`setVirtualServerSeverity(java.lang.String virtualServerSeverity)` Possible values are: `VIRTUAL_SERVER_SEVERITY_GREEN` `VIRTUAL_SERVER_SEVERITY_ORANGE` `VIRTUAL_SERVER_SEVERITY_RED` The severity calculation is based on the overall usage percentage of virtual servers for all load balancer services.
`void`	`setVirtualServerUsagePercentage(java.lang.Double virtualServerUsagePercentage)` Overall virtual server usage percentage for all load balancer services.
`java.lang.String`	`toString()`

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

- Field Detail
  - POOL_MEMBER_SEVERITY_GREEN
```
public static final java.lang.String POOL_MEMBER_SEVERITY_GREEN
```
    See Also:
    
    Constant Field Values
  - POOL_MEMBER_SEVERITY_ORANGE
```
public static final java.lang.String POOL_MEMBER_SEVERITY_ORANGE
```
    See Also:
    
    Constant Field Values
  - POOL_MEMBER_SEVERITY_RED
```
public static final java.lang.String POOL_MEMBER_SEVERITY_RED
```
    See Also:
    
    Constant Field Values
  - POOL_SEVERITY_GREEN
```
public static final java.lang.String POOL_SEVERITY_GREEN
```
    See Also:
    
    Constant Field Values
  - POOL_SEVERITY_ORANGE
```
public static final java.lang.String POOL_SEVERITY_ORANGE
```
    See Also:
    
    Constant Field Values
  - POOL_SEVERITY_RED
```
public static final java.lang.String POOL_SEVERITY_RED
```
    See Also:
    
    Constant Field Values
  - VIRTUAL_SERVER_SEVERITY_GREEN
```
public static final java.lang.String VIRTUAL_SERVER_SEVERITY_GREEN
```
    See Also:
    
    Constant Field Values
  - VIRTUAL_SERVER_SEVERITY_ORANGE
```
public static final java.lang.String VIRTUAL_SERVER_SEVERITY_ORANGE
```
    See Also:
    
    Constant Field Values
  - VIRTUAL_SERVER_SEVERITY_RED
```
public static final java.lang.String VIRTUAL_SERVER_SEVERITY_RED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LBServiceUsageSummary
```
public LBServiceUsageSummary()
```
    Default constructor.
  - LBServiceUsageSummary
```
protected LBServiceUsageSummary(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCurrentPoolCount
```
public java.lang.Long getCurrentPoolCount()
```
    The current count of pools configured for all load balancer services. 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.
  - setCurrentPoolCount
```
public void setCurrentPoolCount(java.lang.Long currentPoolCount)
```
    The current count of pools configured for all load balancer services. 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:
    
    currentPoolCount - New value for the property.
  - getCurrentPoolMemberCount
```
public java.lang.Long getCurrentPoolMemberCount()
```
    The current count of pool members configured for all load balancer services. 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 current count of pool members configured for all load balancer services. 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.
  - getCurrentVirtualServerCount
```
public java.lang.Long getCurrentVirtualServerCount()
```
    The current count of virtual servers configured for all load balancer services. 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.
  - setCurrentVirtualServerCount
```
public void setCurrentVirtualServerCount(java.lang.Long currentVirtualServerCount)
```
    The current count of virtual servers configured for all load balancer services. 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:
    
    currentVirtualServerCount - New value for the property.
  - getPoolCapacity
```
public java.lang.Long getPoolCapacity()
```
    Pool capacity means maximum number of pools which can be configured for all load balancer services. 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.
  - setPoolCapacity
```
public void setPoolCapacity(java.lang.Long poolCapacity)
```
    Pool capacity means maximum number of pools which can be configured for all load balancer services. 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:
    
    poolCapacity - New value for the property.
  - getPoolMemberCapacity
```
public java.lang.Long getPoolMemberCapacity()
```
    Pool capacity means maximum number of pool members which can be configured for all load balancer services. 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 capacity means maximum number of pool members which can be configured for all load balancer services. 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.
  - getPoolMemberSeverity
```
public java.lang.String getPoolMemberSeverity()
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of pool members for all load balancer services. 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.
  - setPoolMemberSeverity
```
public void setPoolMemberSeverity(java.lang.String poolMemberSeverity)
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of pool members for all load balancer services. 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:
    
    poolMemberSeverity - New value for the property.
  - getPoolMemberUsagePercentage
```
public java.lang.Double getPoolMemberUsagePercentage()
```
    Overall pool member usage percentage for all load balancer services. 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.
  - setPoolMemberUsagePercentage
```
public void setPoolMemberUsagePercentage(java.lang.Double poolMemberUsagePercentage)
```
    Overall pool member usage percentage for all load balancer services. 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:
    
    poolMemberUsagePercentage - New value for the property.
  - getPoolSeverity
```
public java.lang.String getPoolSeverity()
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of pools for all load balancer services. 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.
  - setPoolSeverity
```
public void setPoolSeverity(java.lang.String poolSeverity)
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of pools for all load balancer services. 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:
    
    poolSeverity - New value for the property.
  - getPoolUsagePercentage
```
public java.lang.Double getPoolUsagePercentage()
```
    Overall pool usage percentage for all load balancer services. 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.
  - setPoolUsagePercentage
```
public void setPoolUsagePercentage(java.lang.Double poolUsagePercentage)
```
    Overall pool usage percentage for all load balancer services. 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:
    
    poolUsagePercentage - New value for the property.
  - getServiceCounts
```
public java.util.List<LBServiceCountPerSeverity> getServiceCounts()
```
    The service count for each load balancer usage 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.
  - setServiceCounts
```
public void setServiceCounts(java.util.List<LBServiceCountPerSeverity> serviceCounts)
```
    The service count for each load balancer usage 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:
    
    serviceCounts - New value for the property.
  - getServiceUsages
```
public java.util.List<LBServiceUsage> getServiceUsages()
```
    The property identifies all lb service 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.
  - setServiceUsages
```
public void setServiceUsages(java.util.List<LBServiceUsage> serviceUsages)
```
    The property identifies all lb service 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:
    
    serviceUsages - New value for the property.
  - getVirtualServerCapacity
```
public java.lang.Long getVirtualServerCapacity()
```
    Virtual server capacity means maximum number of virtual servers which can be configured for all load balancer services. 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.
  - setVirtualServerCapacity
```
public void setVirtualServerCapacity(java.lang.Long virtualServerCapacity)
```
    Virtual server capacity means maximum number of virtual servers which can be configured for all load balancer services. 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:
    
    virtualServerCapacity - New value for the property.
  - getVirtualServerSeverity
```
public java.lang.String getVirtualServerSeverity()
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of virtual servers for all load balancer services. 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.
  - setVirtualServerSeverity
```
public void setVirtualServerSeverity(java.lang.String virtualServerSeverity)
```
    Possible values are:
    The severity calculation is based on the overall usage percentage of virtual servers for all load balancer services. 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:
    
    virtualServerSeverity - New value for the property.
  - getVirtualServerUsagePercentage
```
public java.lang.Double getVirtualServerUsagePercentage()
```
    Overall virtual server usage percentage for all load balancer services. 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.
  - setVirtualServerUsagePercentage
```
public void setVirtualServerUsagePercentage(java.lang.Double virtualServerUsagePercentage)
```
    Overall virtual server usage percentage for all load balancer services. 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:
    
    virtualServerUsagePercentage - 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 LBServiceUsageSummary _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 LBServiceUsageSummary _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LBServiceUsageSummary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POOL_MEMBER_SEVERITY_GREEN

POOL_MEMBER_SEVERITY_ORANGE

POOL_MEMBER_SEVERITY_RED

POOL_SEVERITY_GREEN

POOL_SEVERITY_ORANGE

POOL_SEVERITY_RED

VIRTUAL_SERVER_SEVERITY_GREEN

VIRTUAL_SERVER_SEVERITY_ORANGE

VIRTUAL_SERVER_SEVERITY_RED

__dynamicStructureFields

Constructor Detail

LBServiceUsageSummary

LBServiceUsageSummary

Method Detail

getCurrentPoolCount

setCurrentPoolCount

getCurrentPoolMemberCount

setCurrentPoolMemberCount

getCurrentVirtualServerCount

setCurrentVirtualServerCount

getPoolCapacity

setPoolCapacity

getPoolMemberCapacity

setPoolMemberCapacity

getPoolMemberSeverity

setPoolMemberSeverity

getPoolMemberUsagePercentage

setPoolMemberUsagePercentage

getPoolSeverity

setPoolSeverity

getPoolUsagePercentage

setPoolUsagePercentage

getServiceCounts

setServiceCounts

getServiceUsages

setServiceUsages

getVirtualServerCapacity

setVirtualServerCapacity

getVirtualServerSeverity

setVirtualServerSeverity

getVirtualServerUsagePercentage

setVirtualServerUsagePercentage

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2