ALBCookieMatch (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBCookieMatch.Builder
Builder class for ALBCookieMatch.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`MATCH_CASE_INSENSITIVE`
`static java.lang.String`	`MATCH_CASE_SENSITIVE`
`static java.lang.String`	`MATCH_CRITERIA_BEGINS_WITH`
`static java.lang.String`	`MATCH_CRITERIA_CONTAINS`
`static java.lang.String`	`MATCH_CRITERIA_DOES_NOT_BEGIN_WITH`
`static java.lang.String`	`MATCH_CRITERIA_DOES_NOT_CONTAIN`
`static java.lang.String`	`MATCH_CRITERIA_DOES_NOT_END_WITH`
`static java.lang.String`	`MATCH_CRITERIA_DOES_NOT_EQUAL`
`static java.lang.String`	`MATCH_CRITERIA_DOES_NOT_EXIST`
`static java.lang.String`	`MATCH_CRITERIA_ENDS_WITH`
`static java.lang.String`	`MATCH_CRITERIA_EQUALS`
`static java.lang.String`	`MATCH_CRITERIA_EXISTS`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBCookieMatch()
Default constructor.

protected ALBCookieMatch(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ALBCookieMatch()` Default constructor.
`protected`	`ALBCookieMatch(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 ALBCookieMatch`	`_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 ALBCookieMatch`	`_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`	`getMatchCase()` Possible values are: `MATCH_CASE_SENSITIVE` `MATCH_CASE_INSENSITIVE` Case sensitivity to use for the match.
`java.lang.String`	`getMatchCriteria()` Possible values are: `MATCH_CRITERIA_EXISTS` `MATCH_CRITERIA_DOES_NOT_EXIST` `MATCH_CRITERIA_BEGINS_WITH` `MATCH_CRITERIA_DOES_NOT_BEGIN_WITH` `MATCH_CRITERIA_CONTAINS` `MATCH_CRITERIA_DOES_NOT_CONTAIN` `MATCH_CRITERIA_ENDS_WITH` `MATCH_CRITERIA_DOES_NOT_END_WITH` `MATCH_CRITERIA_EQUALS` `MATCH_CRITERIA_DOES_NOT_EQUAL` Criterion to use for matching the cookie in the HTTP request.
`java.lang.String`	`getName()` Name of the cookie.
`java.lang.String`	`getValue()` String value in the cookie.
`int`	`hashCode()`
`void`	`setMatchCase(java.lang.String matchCase)` Possible values are: `MATCH_CASE_SENSITIVE` `MATCH_CASE_INSENSITIVE` Case sensitivity to use for the match.
`void`	`setMatchCriteria(java.lang.String matchCriteria)` Possible values are: `MATCH_CRITERIA_EXISTS` `MATCH_CRITERIA_DOES_NOT_EXIST` `MATCH_CRITERIA_BEGINS_WITH` `MATCH_CRITERIA_DOES_NOT_BEGIN_WITH` `MATCH_CRITERIA_CONTAINS` `MATCH_CRITERIA_DOES_NOT_CONTAIN` `MATCH_CRITERIA_ENDS_WITH` `MATCH_CRITERIA_DOES_NOT_END_WITH` `MATCH_CRITERIA_EQUALS` `MATCH_CRITERIA_DOES_NOT_EQUAL` Criterion to use for matching the cookie in the HTTP request.
`void`	`setName(java.lang.String name)` Name of the cookie.
`void`	`setValue(java.lang.String value)` String value in the cookie.
`java.lang.String`	`toString()`

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

- Field Detail
  - MATCH_CASE_SENSITIVE
```
public static final java.lang.String MATCH_CASE_SENSITIVE
```
    See Also:
    
    Constant Field Values
  - MATCH_CASE_INSENSITIVE
```
public static final java.lang.String MATCH_CASE_INSENSITIVE
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_EXISTS
```
public static final java.lang.String MATCH_CRITERIA_EXISTS
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_DOES_NOT_EXIST
```
public static final java.lang.String MATCH_CRITERIA_DOES_NOT_EXIST
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_BEGINS_WITH
```
public static final java.lang.String MATCH_CRITERIA_BEGINS_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_DOES_NOT_BEGIN_WITH
```
public static final java.lang.String MATCH_CRITERIA_DOES_NOT_BEGIN_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_CONTAINS
```
public static final java.lang.String MATCH_CRITERIA_CONTAINS
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_DOES_NOT_CONTAIN
```
public static final java.lang.String MATCH_CRITERIA_DOES_NOT_CONTAIN
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_ENDS_WITH
```
public static final java.lang.String MATCH_CRITERIA_ENDS_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_DOES_NOT_END_WITH
```
public static final java.lang.String MATCH_CRITERIA_DOES_NOT_END_WITH
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_EQUALS
```
public static final java.lang.String MATCH_CRITERIA_EQUALS
```
    See Also:
    
    Constant Field Values
  - MATCH_CRITERIA_DOES_NOT_EQUAL
```
public static final java.lang.String MATCH_CRITERIA_DOES_NOT_EQUAL
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBCookieMatch
```
public ALBCookieMatch()
```
    Default constructor.
  - ALBCookieMatch
```
protected ALBCookieMatch(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getMatchCase
```
public java.lang.String getMatchCase()
```
    Possible values are:
    - MATCH_CASE_SENSITIVE
    - MATCH_CASE_INSENSITIVE
    Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.
    Returns:
    
    The current value of the property.
  - setMatchCase
```
public void setMatchCase(java.lang.String matchCase)
```
    Possible values are:
    - MATCH_CASE_SENSITIVE
    - MATCH_CASE_INSENSITIVE
    Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.
    Parameters:
    
    matchCase - New value for the property.
  - getMatchCriteria
```
public java.lang.String getMatchCriteria()
```
    Possible values are:
    Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
    Returns:
    
    The current value of the property.
  - setMatchCriteria
```
public void setMatchCriteria(java.lang.String matchCriteria)
```
    Possible values are:
    Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
    Parameters:
    
    matchCriteria - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Name of the cookie.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Name of the cookie.
    
    Parameters:
    
    name - New value for the property.
  - getValue
```
public java.lang.String getValue()
```
    String value in the cookie.
    
    Returns:
    
    The current value of the property.
  - setValue
```
public void setValue(java.lang.String value)
```
    String value in the cookie.
    
    Parameters:
    
    value - 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 ALBCookieMatch _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 ALBCookieMatch _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBCookieMatch

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MATCH_CASE_SENSITIVE

MATCH_CASE_INSENSITIVE

MATCH_CRITERIA_EXISTS

MATCH_CRITERIA_DOES_NOT_EXIST

MATCH_CRITERIA_BEGINS_WITH

MATCH_CRITERIA_DOES_NOT_BEGIN_WITH

MATCH_CRITERIA_CONTAINS

MATCH_CRITERIA_DOES_NOT_CONTAIN

MATCH_CRITERIA_ENDS_WITH

MATCH_CRITERIA_DOES_NOT_END_WITH

MATCH_CRITERIA_EQUALS

MATCH_CRITERIA_DOES_NOT_EQUAL

__dynamicStructureFields

Constructor Detail

ALBCookieMatch

ALBCookieMatch

Method Detail

getMatchCase

setMatchCase

getMatchCriteria

setMatchCriteria

getName

setName

getValue

setValue

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2