ALBHttpCookiePersistenceProfile (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBHttpCookiePersistenceProfile
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer HttpCookiePersistenceProfile object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBHttpCookiePersistenceProfile.Builder
Builder class for ALBHttpCookiePersistenceProfile.

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

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ALBHttpCookiePersistenceProfile()` Default constructor.
`protected`	`ALBHttpCookiePersistenceProfile(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 ALBHttpCookiePersistenceProfile`	`_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 ALBHttpCookiePersistenceProfile`	`_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.Boolean`	`getAlwaysSendCookie()` If no persistence cookie was received from the client, always send it.
`java.lang.String`	`getCookieName()` HTTP cookie name for cookie persistence.
`java.lang.String`	`getEncryptionKey()` Key name to use for cookie encryption.
`java.util.List<ALBHttpCookiePersistenceKey>`	`getKey()` Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type array.
`java.lang.Long`	`getTimeout()` The maximum lifetime of any session cookie.
`int`	`hashCode()`
`void`	`setAlwaysSendCookie(java.lang.Boolean alwaysSendCookie)` If no persistence cookie was received from the client, always send it.
`void`	`setCookieName(java.lang.String cookieName)` HTTP cookie name for cookie persistence.
`void`	`setEncryptionKey(java.lang.String encryptionKey)` Key name to use for cookie encryption.
`void`	`setKey(java.util.List<ALBHttpCookiePersistenceKey> key)` Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type array.
`void`	`setTimeout(java.lang.Long timeout)` The maximum lifetime of any session cookie.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBHttpCookiePersistenceProfile
```
public ALBHttpCookiePersistenceProfile()
```
    Default constructor.
  - ALBHttpCookiePersistenceProfile
```
protected ALBHttpCookiePersistenceProfile(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAlwaysSendCookie
```
public java.lang.Boolean getAlwaysSendCookie()
```
    If no persistence cookie was received from the client, always send it. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setAlwaysSendCookie
```
public void setAlwaysSendCookie(java.lang.Boolean alwaysSendCookie)
```
    If no persistence cookie was received from the client, always send it. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    alwaysSendCookie - New value for the property.
  - getCookieName
```
public java.lang.String getCookieName()
```
    HTTP cookie name for cookie persistence.
    
    Returns:
    
    The current value of the property.
  - setCookieName
```
public void setCookieName(java.lang.String cookieName)
```
    HTTP cookie name for cookie persistence.
    
    Parameters:
    
    cookieName - New value for the property.
  - getEncryptionKey
```
public java.lang.String getEncryptionKey()
```
    Key name to use for cookie encryption.
    
    Returns:
    
    The current value of the property.
  - setEncryptionKey
```
public void setEncryptionKey(java.lang.String encryptionKey)
```
    Key name to use for cookie encryption.
    
    Parameters:
    
    encryptionKey - New value for the property.
  - getKey
```
public java.util.List<ALBHttpCookiePersistenceKey> getKey()
```
    Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type array.
    
    Returns:
    
    The current value of the property.
  - setKey
```
public void setKey(java.util.List<ALBHttpCookiePersistenceKey> key)
```
    Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type array.
    
    Parameters:
    
    key - New value for the property.
  - getTimeout
```
public java.lang.Long getTimeout()
```
    The maximum lifetime of any session cookie. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- 'No Timeout'. Unit is MIN. format: int64
    
    Returns:
    
    The current value of the property.
  - setTimeout
```
public void setTimeout(java.lang.Long timeout)
```
    The maximum lifetime of any session cookie. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- 'No Timeout'. Unit is MIN. format: int64
    
    Parameters:
    
    timeout - 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 ALBHttpCookiePersistenceProfile _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 ALBHttpCookiePersistenceProfile _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBHttpCookiePersistenceProfile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ALBHttpCookiePersistenceProfile

ALBHttpCookiePersistenceProfile

Method Detail

getAlwaysSendCookie

setAlwaysSendCookie

getCookieName

setCookieName

getEncryptionKey

setEncryptionKey

getKey

setKey

getTimeout

setTimeout

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2