com.vmware.nsx_global_policy.model

Class ALBHttpCacheConfig.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBHttpCacheConfig.Builder

Enclosing class:

ALBHttpCacheConfig

public static final class ALBHttpCacheConfig.Builder
extends java.lang.Object

Builder class for ALBHttpCacheConfig.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of ALBHttpCacheConfig.

Method Summary

Modifier and Type	Method and Description
ALBHttpCacheConfig	build()
ALBHttpCacheConfig.Builder	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.
ALBHttpCacheConfig.Builder	setAggressive(java.lang.Boolean aggressive) Enable/disable caching objects without Cache-Control headers.
ALBHttpCacheConfig.Builder	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.
ALBHttpCacheConfig.Builder	setDefaultExpire(java.lang.Long defaultExpire) Default expiration time of cache objects received from the server without a Cache-Control expiration header.
ALBHttpCacheConfig.Builder	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).
ALBHttpCacheConfig.Builder	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.
ALBHttpCacheConfig.Builder	setIgnoreRequestCacheControl(java.lang.Boolean ignoreRequestCacheControl) Ignore client's cache control headers when fetching or storing from and to the cache.
ALBHttpCacheConfig.Builder	setMaxCacheSize(java.lang.Long maxCacheSize) Max size, in bytes, of the cache.
ALBHttpCacheConfig.Builder	setMaxObjectSize(java.lang.Long maxObjectSize) Maximum size of an object to store in the cache.
ALBHttpCacheConfig.Builder	setMimeTypesBlockGroupPaths(java.util.List<java.lang.String> mimeTypesBlockGroupPaths) Blocklist string group of non-cacheable mime types.
ALBHttpCacheConfig.Builder	setMimeTypesBlockLists(java.util.List<java.lang.String> mimeTypesBlockLists) Blocklist of non-cacheable mime types.
ALBHttpCacheConfig.Builder	setMimeTypesGroupPaths(java.util.List<java.lang.String> mimeTypesGroupPaths) Allowlist string group of cacheable mime types.
ALBHttpCacheConfig.Builder	setMimeTypesList(java.util.List<java.lang.String> mimeTypesList) Allowlist of cacheable mime types.
ALBHttpCacheConfig.Builder	setMinObjectSize(java.lang.Long minObjectSize) Minimum size of an object to store in the cache.
ALBHttpCacheConfig.Builder	setQueryCacheable(java.lang.Boolean queryCacheable) Allow caching of objects whose URI included a query argument.
ALBHttpCacheConfig.Builder	setUriNonCacheable(ALBPathMatch uriNonCacheable)
ALBHttpCacheConfig.Builder	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of ALBHttpCacheConfig.

Method Detail

setAgeHeader

public ALBHttpCacheConfig.Builder 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.

setAggressive

public ALBHttpCacheConfig.Builder 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.

setDateHeader

public ALBHttpCacheConfig.Builder 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.

setDefaultExpire

public ALBHttpCacheConfig.Builder 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.

setEnabled

public ALBHttpCacheConfig.Builder 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.

setHeuristicExpire

public ALBHttpCacheConfig.Builder 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.

setIgnoreRequestCacheControl

public ALBHttpCacheConfig.Builder 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.

setMaxCacheSize

public ALBHttpCacheConfig.Builder 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.

setMaxObjectSize

public ALBHttpCacheConfig.Builder 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.

setMimeTypesBlockGroupPaths

public ALBHttpCacheConfig.Builder 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.

setMimeTypesBlockLists

public ALBHttpCacheConfig.Builder setMimeTypesBlockLists(java.util.List<java.lang.String> mimeTypesBlockLists)

Blocklist of non-cacheable mime types.

Parameters:

mimeTypesBlockLists - New value for the property.

setMimeTypesGroupPaths

public ALBHttpCacheConfig.Builder 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.

setMimeTypesList

public ALBHttpCacheConfig.Builder 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.

setMinObjectSize

public ALBHttpCacheConfig.Builder 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.

setQueryCacheable

public ALBHttpCacheConfig.Builder 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.

setUriNonCacheable

public ALBHttpCacheConfig.Builder setUriNonCacheable(ALBPathMatch uriNonCacheable)

Parameters:

uriNonCacheable - New value for the property.

setXcacheHeader

public ALBHttpCacheConfig.Builder 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.

build

public ALBHttpCacheConfig build()