Package com.vmware.nsx.model

Class LbRuleCondition

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class LbRuleCondition
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Match conditions are used to match application traffic passing through load balancers. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion for application traffic. If inverse field is set to true, the match result of the condition is inverted. If more than one match condition is specified, match strategy determines if all conditions should match or any one condition should match for the load balancer rule to be considered a match. Currently only HTTP messages are supported by load balancer rules. Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. Each phase supports certain types of match conditions, supported match conditions in HTTP_REQUEST_REWRITE phase are: LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition Supported match conditions in HTTP_FORWARDING phase are: LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition LbSslSniCondition Supported match condition in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderCondition LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition Supported match condition in HTTP_ACCESS phase is: LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition Supported match condition in TRANSPORT phase is: LbSslSniCondition
    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

      • TYPE_LBHTTPREQUESTMETHODCONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTMETHODCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTURICONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTURICONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTVERSIONCONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTVERSIONCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTHEADERCONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTHEADERCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTCOOKIECONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTCOOKIECONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPREQUESTBODYCONDITION

        public static final java.lang.String TYPE_LBHTTPREQUESTBODYCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPRESPONSEHEADERCONDITION

        public static final java.lang.String TYPE_LBHTTPRESPONSEHEADERCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBTCPHEADERCONDITION

        public static final java.lang.String TYPE_LBTCPHEADERCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBIPHEADERCONDITION

        public static final java.lang.String TYPE_LBIPHEADERCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBVARIABLECONDITION

        public static final java.lang.String TYPE_LBVARIABLECONDITION
        See Also:
        Constant Field Values

      • TYPE_LBHTTPSSLCONDITION

        public static final java.lang.String TYPE_LBHTTPSSLCONDITION
        See Also:
        Constant Field Values

      • TYPE_LBSSLSNICONDITION

        public static final java.lang.String TYPE_LBSSLSNICONDITION
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • LbRuleCondition

        public LbRuleCondition()
        Default constructor.

      • LbRuleCondition

        protected LbRuleCondition​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getInverse

        public java.lang.Boolean getInverse()
        A flag to indicate whether reverse the match result of this condition
        Returns:
        The current value of the property.

      • setInverse

        public void setInverse​(java.lang.Boolean inverse)
        A flag to indicate whether reverse the match result of this condition
        Parameters:
        inverse - 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 LbRuleCondition _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 LbRuleCondition _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.