LBVariablePersistenceOnAction (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.LBVariablePersistenceOnAction

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LBVariablePersistenceOnAction
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This action is performed in HTTP forwarding phase. It is used to inspect the variable of HTTP request, and look up the persistence entry with its value and pool uuid as key. If the persistence entry is found, the HTTP request is forwarded to the recorded backend server according to the persistence entry. If the persistence entry is not found, a new entry is created in the table after backend server is selected.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LBVariablePersistenceOnAction.Builder
Builder class for LBVariablePersistenceOnAction.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LBVariablePersistenceOnAction()` Default constructor.
`protected`	`LBVariablePersistenceOnAction(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 LBVariablePersistenceOnAction`	`_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 LBVariablePersistenceOnAction`	`_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.String`	`getPersistenceProfilePath()` If the persistence profile path is not specified, a default persistence table is created per virtual server.
`java.lang.String`	`getType()` Possible values are: `LBRuleAction.TYPE_LBSELECTPOOLACTION` `LBRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREJECTACTION` `LBRuleAction.TYPE_LBHTTPREDIRECTACTION` `LBRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTION` `LBRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTION` `LBRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION` `LBRuleAction.TYPE_LBVARIABLEPERSISTENCEONACTION` `LBRuleAction.TYPE_LBVARIABLEPERSISTENCELEARNACTION` `LBRuleAction.TYPE_LBJWTAUTHACTION` `LBRuleAction.TYPE_LBSSLMODESELECTIONACTION` `LBRuleAction.TYPE_LBCONNECTIONDROPACTION` The property identifies the load balancer rule action type.
`java.lang.Boolean`	`getVariableHashEnabled()` The property is used to enable a hash operation for variable value when composing the persistence key.
`java.lang.String`	`getVariableName()` The property is the name of variable to be used.
`int`	`hashCode()`
`void`	`setPersistenceProfilePath(java.lang.String persistenceProfilePath)` If the persistence profile path is not specified, a default persistence table is created per virtual server.
`void`	`setVariableHashEnabled(java.lang.Boolean variableHashEnabled)` The property is used to enable a hash operation for variable value when composing the persistence key.
`void`	`setVariableName(java.lang.String variableName)` The property is the name of variable to be used.
`java.lang.String`	`toString()`

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

- 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
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LBVariablePersistenceOnAction
```
public LBVariablePersistenceOnAction()
```
    Default constructor.
  - LBVariablePersistenceOnAction
```
protected LBVariablePersistenceOnAction(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getPersistenceProfilePath
```
public java.lang.String getPersistenceProfilePath()
```
    If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.
    
    Returns:
    
    The current value of the property.
  - setPersistenceProfilePath
```
public void setPersistenceProfilePath(java.lang.String persistenceProfilePath)
```
    If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.
    
    Parameters:
    
    persistenceProfilePath - New value for the property.
  - getVariableHashEnabled
```
public java.lang.Boolean getVariableHashEnabled()
```
    The property is used to enable a hash operation for variable value when composing the persistence key.
    
    Returns:
    
    The current value of the property.
  - setVariableHashEnabled
```
public void setVariableHashEnabled(java.lang.Boolean variableHashEnabled)
```
    The property is used to enable a hash operation for variable value when composing the persistence key.
    
    Parameters:
    
    variableHashEnabled - New value for the property.
  - getVariableName
```
public java.lang.String getVariableName()
```
    The property is the name of variable to be used. It specifies which variable's value of a HTTP Request will be used in the key of persistence entry. The variable can be a built-in variable such as \"_cookie_JSESSIONID\", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as \"article\". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.
    
    Returns:
    
    The current value of the property.
  - setVariableName
```
public void setVariableName(java.lang.String variableName)
```
    The property is the name of variable to be used. It specifies which variable's value of a HTTP Request will be used in the key of persistence entry. The variable can be a built-in variable such as \"_cookie_JSESSIONID\", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as \"article\". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.
    
    Parameters:
    
    variableName - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    The property identifies the load balancer rule action type. The value of this property is automatically populated to "LBVariablePersistenceOnAction".
    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 LBVariablePersistenceOnAction _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 LBVariablePersistenceOnAction _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LBVariablePersistenceOnAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

__dynamicStructureFields

Constructor Detail

LBVariablePersistenceOnAction

LBVariablePersistenceOnAction

Method Detail

getPersistenceProfilePath

setPersistenceProfilePath

getVariableHashEnabled

setVariableHashEnabled

getVariableName

setVariableName

getType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2