Class LBServiceUsage

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class LBServiceUsage
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Describes the capacity and current usage of virtual servers, pools and pool members for the given load balancer service.
    See Also:
    Serialized Form
    • Field Detail

      • _TYPE_IDENTIFIER

        public static final java.lang.String _TYPE_IDENTIFIER
        Identifier denoting this class, when it is used in polymorphic context.

        This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.

        See Also:
        Constant Field Values
      • SERVICE_SIZE_SMALL

        public static final java.lang.String SERVICE_SIZE_SMALL
        See Also:
        Constant Field Values
      • SERVICE_SIZE_MEDIUM

        public static final java.lang.String SERVICE_SIZE_MEDIUM
        See Also:
        Constant Field Values
      • SERVICE_SIZE_LARGE

        public static final java.lang.String SERVICE_SIZE_LARGE
        See Also:
        Constant Field Values
      • SERVICE_SIZE_XLARGE

        public static final java.lang.String SERVICE_SIZE_XLARGE
        See Also:
        Constant Field Values
      • SERVICE_SIZE_DLB

        public static final java.lang.String SERVICE_SIZE_DLB
        See Also:
        Constant Field Values
      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • LBServiceUsage

        public LBServiceUsage()
        Default constructor.
      • LBServiceUsage

        protected LBServiceUsage​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getCurrentPoolCount

        public java.lang.Long getCurrentPoolCount()
        The current number of pools which has been configured in the given load balancer service. 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 number of pools which has been configured in the given load balancer service. 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 number of pool members which has been configured in the given load balancer service. 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 number of pool members which has been configured in the given load balancer service. 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 number of virtual servers which has been configured in the given load balancer service. 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 number of virtual servers which has been configured in the given load balancer service. 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.
      • getLastUpdateTimestamp

        public java.lang.Long getLastUpdateTimestamp()
        Timestamp when the data was last updated. format: int64
        Returns:
        The current value of the property.
      • setLastUpdateTimestamp

        public void setLastUpdateTimestamp​(java.lang.Long lastUpdateTimestamp)
        Timestamp when the data was last updated. format: int64
        Parameters:
        lastUpdateTimestamp - New value for the property.
      • getPoolCapacity

        public java.lang.Long getPoolCapacity()
        Pool capacity means maximum number of pools which could be configured in the given load balancer service. 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 could be configured in the given load balancer service. 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 member capacity means maximum number of pool members which could be configured in the given load balancer service. 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 could be configured in the given load balancer service. 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.
      • getServicePath

        public java.lang.String getServicePath()
        LBService object path. 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.
      • setServicePath

        public void setServicePath​(java.lang.String servicePath)
        LBService object path. 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:
        servicePath - New value for the property.
      • getSeverity

        public java.lang.String getSeverity()
        Possible values are: The severity calculation is based on the largest usage percentage from virtual servers, pools and pool members for one load balancer service. 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 the largest usage percentage from virtual servers, pools and pool members for one load balancer service. 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 usage percentage is the largest usage percentage from virtual servers, pools and pool members for the load balancer service. If the property relax_scale_validation is set as true for LBService, it is possible that the value is larger than 100.0. For example, if SMALL LBS is deployed on MEDIUM edge node and configured with MEDIUM LBS virtual server scale number, LBS usage percentage is shown larger than 100.0. 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 usage percentage is the largest usage percentage from virtual servers, pools and pool members for the load balancer service. If the property relax_scale_validation is set as true for LBService, it is possible that the value is larger than 100.0. For example, if SMALL LBS is deployed on MEDIUM edge node and configured with MEDIUM LBS virtual server scale number, LBS usage percentage is shown larger than 100.0. 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.
      • getVirtualServerCapacity

        public java.lang.Long getVirtualServerCapacity()
        Virtual server capacity means maximum number of virtual servers which could be configured in the given load balancer service. 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 could be configured in the given load balancer service. 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.
      • 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.
      • getResourceType

        public java.lang.String getResourceType()
        The value of this property is automatically populated to "LBServiceUsage".
        Returns:
        The current value of 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 LBServiceUsage _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 LBServiceUsage _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.