Package io.fabric8.kubernetes.api.model.gatewayapi.v1

Class HTTPRouteFilter

java.lang.Object

io.fabric8.kubernetes.api.model.gatewayapi.v1.HTTPRouteFilter

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<HTTPRouteFilterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HTTPRouteFilter
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HTTPRouteFilterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTTPRouteFilter()	No args constructor for use in serialization
HTTPRouteFilter(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef, HTTPHeaderFilter requestHeaderModifier, HTTPRequestMirrorFilter requestMirror, HTTPRequestRedirectFilter requestRedirect, HTTPHeaderFilter responseHeaderModifier, String type, HTTPURLRewriteFilter urlRewrite)

Method Summary

Modifier and Type	Method	Description
HTTPRouteFilterBuilder	edit()
Map<String,Object>	getAdditionalProperties()
io.fabric8.kubernetes.api.model.LocalObjectReference	getExtensionRef()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPHeaderFilter	getRequestHeaderModifier()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPRequestMirrorFilter	getRequestMirror()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPRequestRedirectFilter	getRequestRedirect()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPHeaderFilter	getResponseHeaderModifier()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
String	getType()	Type identifies the type of filter to apply.
HTTPURLRewriteFilter	getUrlRewrite()	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setExtensionRef(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setRequestHeaderModifier(HTTPHeaderFilter requestHeaderModifier)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setRequestMirror(HTTPRequestMirrorFilter requestMirror)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setRequestRedirect(HTTPRequestRedirectFilter requestRedirect)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setResponseHeaderModifier(HTTPHeaderFilter responseHeaderModifier)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setType(String type)	Type identifies the type of filter to apply.
void	setUrlRewrite(HTTPURLRewriteFilter urlRewrite)	HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPRouteFilterBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRouteFilter

public HTTPRouteFilter()

No args constructor for use in serialization

HTTPRouteFilter

public HTTPRouteFilter(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef,
                       HTTPHeaderFilter requestHeaderModifier,
                       HTTPRequestMirrorFilter requestMirror,
                       HTTPRequestRedirectFilter requestRedirect,
                       HTTPHeaderFilter responseHeaderModifier,
                       String type,
                       HTTPURLRewriteFilter urlRewrite)

Method Detail

getExtensionRef

public io.fabric8.kubernetes.api.model.LocalObjectReference getExtensionRef()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setExtensionRef

public void setExtensionRef(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

getRequestHeaderModifier

public HTTPHeaderFilter getRequestHeaderModifier()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setRequestHeaderModifier

public void setRequestHeaderModifier(HTTPHeaderFilter requestHeaderModifier)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

getRequestMirror

public HTTPRequestMirrorFilter getRequestMirror()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setRequestMirror

public void setRequestMirror(HTTPRequestMirrorFilter requestMirror)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

getRequestRedirect

public HTTPRequestRedirectFilter getRequestRedirect()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setRequestRedirect

public void setRequestRedirect(HTTPRequestRedirectFilter requestRedirect)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

getResponseHeaderModifier

public HTTPHeaderFilter getResponseHeaderModifier()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setResponseHeaderModifier

public void setResponseHeaderModifier(HTTPHeaderFilter responseHeaderModifier)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

getType

public String getType()

Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:

- Core: Filter types and their corresponding configuration defined by

"Support: Core" in this package, e.g. "RequestHeaderModifier". All

implementations must support core filters.

- Extended: Filter types and their corresponding configuration defined by

"Support: Extended" in this package, e.g. "RequestMirror". Implementers

are encouraged to support extended filters.

- Implementation-specific: Filters that are defined and supported by

specific vendors.

In the future, filters showing convergence in behavior across multiple

implementations will be considered for inclusion in extended or core

conformance levels. Filter-specific configuration for such filters

is specified using the ExtensionRef field. `Type` should be set to

"ExtensionRef" for custom filters.

Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.

If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

setType

public void setType(String type)

Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:

- Core: Filter types and their corresponding configuration defined by

"Support: Core" in this package, e.g. "RequestHeaderModifier". All

implementations must support core filters.

- Extended: Filter types and their corresponding configuration defined by

"Support: Extended" in this package, e.g. "RequestMirror". Implementers

are encouraged to support extended filters.

- Implementation-specific: Filters that are defined and supported by

specific vendors.

In the future, filters showing convergence in behavior across multiple

implementations will be considered for inclusion in extended or core

conformance levels. Filter-specific configuration for such filters

is specified using the ExtensionRef field. `Type` should be set to

"ExtensionRef" for custom filters.

Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.

If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

getUrlRewrite

public HTTPURLRewriteFilter getUrlRewrite()

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

setUrlRewrite

public void setUrlRewrite(HTTPURLRewriteFilter urlRewrite)

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

edit

public HTTPRouteFilterBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<HTTPRouteFilterBuilder>

toBuilder

public HTTPRouteFilterBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)