ALBHttpCacheConfig (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBHttpCacheConfig.Builder
Builder class for ALBHttpCacheConfig.

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

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

ALBHttpCacheConfig()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ALBHttpCacheConfig()` Default constructor.
`protected`	`ALBHttpCacheConfig(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 ALBHttpCacheConfig`	`_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 ALBHttpCacheConfig`	`_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`	`getAgeHeader()` Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache.
`java.lang.Boolean`	`getAggressive()` Enable/disable caching objects without Cache-Control headers.
`java.lang.Boolean`	`getDateHeader()` If a Date header was not added by the server, add a Date header to the object served from cache.
`java.lang.Long`	`getDefaultExpire()` Default expiration time of cache objects received from the server without a Cache-Control expiration header.
`java.lang.Boolean`	`getEnabled()` Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value).
`java.lang.Boolean`	`getHeuristicExpire()` If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration.
`java.lang.Boolean`	`getIgnoreRequestCacheControl()` Ignore client's cache control headers when fetching or storing from and to the cache.
`java.lang.Long`	`getMaxCacheSize()` Max size, in bytes, of the cache.
`java.lang.Long`	`getMaxObjectSize()` Maximum size of an object to store in the cache.
`java.util.List<java.lang.String>`	`getMimeTypesBlockGroupPaths()` Blocklist string group of non-cacheable mime types.
`java.util.List<java.lang.String>`	`getMimeTypesBlockLists()` Blocklist of non-cacheable mime types.
`java.util.List<java.lang.String>`	`getMimeTypesGroupPaths()` Allowlist string group of cacheable mime types.
`java.util.List<java.lang.String>`	`getMimeTypesList()` Allowlist of cacheable mime types.
`java.lang.Long`	`getMinObjectSize()` Minimum size of an object to store in the cache.
`java.lang.Boolean`	`getQueryCacheable()` Allow caching of objects whose URI included a query argument.
`ALBPathMatch`	`getUriNonCacheable()`
`java.lang.Boolean`	`getXcacheHeader()` Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache.
`int`	`hashCode()`
`void`	`setAgeHeader(java.lang.Boolean ageHeader)` Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache.
`void`	`setAggressive(java.lang.Boolean aggressive)` Enable/disable caching objects without Cache-Control headers.
`void`	`setDateHeader(java.lang.Boolean dateHeader)` If a Date header was not added by the server, add a Date header to the object served from cache.
`void`	`setDefaultExpire(java.lang.Long defaultExpire)` Default expiration time of cache objects received from the server without a Cache-Control expiration header.
`void`	`setEnabled(java.lang.Boolean enabled)` Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value).
`void`	`setHeuristicExpire(java.lang.Boolean heuristicExpire)` If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration.
`void`	`setIgnoreRequestCacheControl(java.lang.Boolean ignoreRequestCacheControl)` Ignore client's cache control headers when fetching or storing from and to the cache.
`void`	`setMaxCacheSize(java.lang.Long maxCacheSize)` Max size, in bytes, of the cache.
`void`	`setMaxObjectSize(java.lang.Long maxObjectSize)` Maximum size of an object to store in the cache.
`void`	`setMimeTypesBlockGroupPaths(java.util.List<java.lang.String> mimeTypesBlockGroupPaths)` Blocklist string group of non-cacheable mime types.
`void`	`setMimeTypesBlockLists(java.util.List<java.lang.String> mimeTypesBlockLists)` Blocklist of non-cacheable mime types.
`void`	`setMimeTypesGroupPaths(java.util.List<java.lang.String> mimeTypesGroupPaths)` Allowlist string group of cacheable mime types.
`void`	`setMimeTypesList(java.util.List<java.lang.String> mimeTypesList)` Allowlist of cacheable mime types.
`void`	`setMinObjectSize(java.lang.Long minObjectSize)` Minimum size of an object to store in the cache.
`void`	`setQueryCacheable(java.lang.Boolean queryCacheable)` Allow caching of objects whose URI included a query argument.
`void`	`setUriNonCacheable(ALBPathMatch uriNonCacheable)`
`void`	`setXcacheHeader(java.lang.Boolean xcacheHeader)` Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache.
`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
  - ALBHttpCacheConfig
```
public ALBHttpCacheConfig()
```
    Default constructor.
  - ALBHttpCacheConfig
```
protected ALBHttpCacheConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAgeHeader
```
public java.lang.Boolean getAgeHeader()
```
    Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setAgeHeader
```
public void setAgeHeader(java.lang.Boolean ageHeader)
```
    Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    ageHeader - New value for the property.
  - getAggressive
```
public java.lang.Boolean getAggressive()
```
    Enable/disable caching objects without Cache-Control headers. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setAggressive
```
public void setAggressive(java.lang.Boolean aggressive)
```
    Enable/disable caching objects without Cache-Control headers. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    aggressive - New value for the property.
  - getDateHeader
```
public java.lang.Boolean getDateHeader()
```
    If a Date header was not added by the server, add a Date header to the object served from cache. This indicates to the client when the object was originally sent by the server to the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setDateHeader
```
public void setDateHeader(java.lang.Boolean dateHeader)
```
    If a Date header was not added by the server, add a Date header to the object served from cache. This indicates to the client when the object was originally sent by the server to the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    dateHeader - New value for the property.
  - getDefaultExpire
```
public java.lang.Long getDefaultExpire()
```
    Default expiration time of cache objects received from the server without a Cache-Control expiration header. This value may be overwritten by the Heuristic Expire setting. Default value when not specified in API or module is interpreted by ALB Controller as 600. format: int64
    
    Returns:
    
    The current value of the property.
  - setDefaultExpire
```
public void setDefaultExpire(java.lang.Long defaultExpire)
```
    Default expiration time of cache objects received from the server without a Cache-Control expiration header. This value may be overwritten by the Heuristic Expire setting. Default value when not specified in API or module is interpreted by ALB Controller as 600. format: int64
    
    Parameters:
    
    defaultExpire - New value for the property.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value). Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value). Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    enabled - New value for the property.
  - getHeuristicExpire
```
public java.lang.Boolean getHeuristicExpire()
```
    If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration. If unable to solicit an Last-Modified header, then the system will fall back to the Cache Expire Time value. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setHeuristicExpire
```
public void setHeuristicExpire(java.lang.Boolean heuristicExpire)
```
    If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration. If unable to solicit an Last-Modified header, then the system will fall back to the Cache Expire Time value. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    heuristicExpire - New value for the property.
  - getIgnoreRequestCacheControl
```
public java.lang.Boolean getIgnoreRequestCacheControl()
```
    Ignore client's cache control headers when fetching or storing from and to the cache. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setIgnoreRequestCacheControl
```
public void setIgnoreRequestCacheControl(java.lang.Boolean ignoreRequestCacheControl)
```
    Ignore client's cache control headers when fetching or storing from and to the cache. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    ignoreRequestCacheControl - New value for the property.
  - getMaxCacheSize
```
public java.lang.Long getMaxCacheSize()
```
    Max size, in bytes, of the cache. The default, zero, indicates auto configuration. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaxCacheSize
```
public void setMaxCacheSize(java.lang.Long maxCacheSize)
```
    Max size, in bytes, of the cache. The default, zero, indicates auto configuration. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64
    
    Parameters:
    
    maxCacheSize - New value for the property.
  - getMaxObjectSize
```
public java.lang.Long getMaxObjectSize()
```
    Maximum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 4194304. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaxObjectSize
```
public void setMaxObjectSize(java.lang.Long maxObjectSize)
```
    Maximum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 4194304. format: int64
    
    Parameters:
    
    maxObjectSize - New value for the property.
  - getMimeTypesBlockGroupPaths
```
public java.util.List<java.lang.String> getMimeTypesBlockGroupPaths()
```
    Blocklist string group of non-cacheable mime types. It is a reference to an object of type StringGroup.
    
    Returns:
    
    The current value of the property.
  - setMimeTypesBlockGroupPaths
```
public void setMimeTypesBlockGroupPaths(java.util.List<java.lang.String> mimeTypesBlockGroupPaths)
```
    Blocklist string group of non-cacheable mime types. It is a reference to an object of type StringGroup.
    
    Parameters:
    
    mimeTypesBlockGroupPaths - New value for the property.
  - getMimeTypesBlockLists
```
public java.util.List<java.lang.String> getMimeTypesBlockLists()
```
    Blocklist of non-cacheable mime types.
    
    Returns:
    
    The current value of the property.
  - setMimeTypesBlockLists
```
public void setMimeTypesBlockLists(java.util.List<java.lang.String> mimeTypesBlockLists)
```
    Blocklist of non-cacheable mime types.
    
    Parameters:
    
    mimeTypesBlockLists - New value for the property.
  - getMimeTypesGroupPaths
```
public java.util.List<java.lang.String> getMimeTypesGroupPaths()
```
    Allowlist string group of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR). It is a reference to an object of type StringGroup.
    
    Returns:
    
    The current value of the property.
  - setMimeTypesGroupPaths
```
public void setMimeTypesGroupPaths(java.util.List<java.lang.String> mimeTypesGroupPaths)
```
    Allowlist string group of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR). It is a reference to an object of type StringGroup.
    
    Parameters:
    
    mimeTypesGroupPaths - New value for the property.
  - getMimeTypesList
```
public java.util.List<java.lang.String> getMimeTypesList()
```
    Allowlist of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR).
    
    Returns:
    
    The current value of the property.
  - setMimeTypesList
```
public void setMimeTypesList(java.util.List<java.lang.String> mimeTypesList)
```
    Allowlist of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR).
    
    Parameters:
    
    mimeTypesList - New value for the property.
  - getMinObjectSize
```
public java.lang.Long getMinObjectSize()
```
    Minimum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64
    
    Returns:
    
    The current value of the property.
  - setMinObjectSize
```
public void setMinObjectSize(java.lang.Long minObjectSize)
```
    Minimum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64
    
    Parameters:
    
    minObjectSize - New value for the property.
  - getQueryCacheable
```
public java.lang.Boolean getQueryCacheable()
```
    Allow caching of objects whose URI included a query argument. When disabled, these objects are not cached. When enabled, the request must match the URI query to be considered a hit. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setQueryCacheable
```
public void setQueryCacheable(java.lang.Boolean queryCacheable)
```
    Allow caching of objects whose URI included a query argument. When disabled, these objects are not cached. When enabled, the request must match the URI query to be considered a hit. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    queryCacheable - New value for the property.
  - getUriNonCacheable
```
public ALBPathMatch getUriNonCacheable()
```
    Returns:
    
    The current value of the property.
  - setUriNonCacheable
```
public void setUriNonCacheable(ALBPathMatch uriNonCacheable)
```
    Parameters:
    
    uriNonCacheable - New value for the property.
  - getXcacheHeader
```
public java.lang.Boolean getXcacheHeader()
```
    Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setXcacheHeader
```
public void setXcacheHeader(java.lang.Boolean xcacheHeader)
```
    Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    xcacheHeader - 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 ALBHttpCacheConfig _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 ALBHttpCacheConfig _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBHttpCacheConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ALBHttpCacheConfig

ALBHttpCacheConfig

Method Detail

getAgeHeader

setAgeHeader

getAggressive

setAggressive

getDateHeader

setDateHeader

getDefaultExpire

setDefaultExpire

getEnabled

setEnabled

getHeuristicExpire

setHeuristicExpire

getIgnoreRequestCacheControl

setIgnoreRequestCacheControl

getMaxCacheSize

setMaxCacheSize

getMaxObjectSize

setMaxObjectSize

getMimeTypesBlockGroupPaths

setMimeTypesBlockGroupPaths

getMimeTypesBlockLists

setMimeTypesBlockLists

getMimeTypesGroupPaths

setMimeTypesGroupPaths

getMimeTypesList

setMimeTypesList

getMinObjectSize

setMinObjectSize

getQueryCacheable

setQueryCacheable

getUriNonCacheable

setUriNonCacheable

getXcacheHeader

setXcacheHeader

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2