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

Class HTTPHeaderFilter

java.lang.Object

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

All Implemented Interfaces:

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

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

HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request or response. Only one action for a given header name is permitted. Filters specifying multiple actions of the same or different type for any one header name are invalid. Configuration to set or add multiple values for a header must use RFC 7230 header value formatting, separating each value with a comma.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTTPHeaderFilter()	No args constructor for use in serialization
HTTPHeaderFilter(List<HTTPHeader> add, List<String> remove, List<HTTPHeader> set)

Method Summary

Modifier and Type	Method	Description
HTTPHeaderFilterBuilder	edit()
List<HTTPHeader>	getAdd()	Add adds the given header(s) (name, value) to the request before the action.
Map<String,Object>	getAdditionalProperties()
List<String>	getRemove()	Remove the given header(s) from the HTTP request before the action.
List<HTTPHeader>	getSet()	Set overwrites the request with the given header (name, value) before the action.
void	setAdd(List<HTTPHeader> add)	Add adds the given header(s) (name, value) to the request before the action.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setRemove(List<String> remove)	Remove the given header(s) from the HTTP request before the action.
void	setSet(List<HTTPHeader> set)	Set overwrites the request with the given header (name, value) before the action.
HTTPHeaderFilterBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPHeaderFilter

public HTTPHeaderFilter()

No args constructor for use in serialization

HTTPHeaderFilter

public HTTPHeaderFilter(List<HTTPHeader> add,
                        List<String> remove,
                        List<HTTPHeader> set)

Method Detail

getAdd

public List<HTTPHeader> getAdd()

Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name.

Input:

GET /foo HTTP/1.1

my-header: foo

Config:

add:

- name: "my-header"

value: "bar,baz"

Output:

GET /foo HTTP/1.1

my-header: foo,bar,baz

setAdd

public void setAdd(List<HTTPHeader> add)

Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name.

Input:

GET /foo HTTP/1.1

my-header: foo

Config:

add:

- name: "my-header"

value: "bar,baz"

Output:

GET /foo HTTP/1.1

my-header: foo,bar,baz

getRemove

public List<String> getRemove()

Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

Input:

GET /foo HTTP/1.1

my-header1: foo

my-header2: bar

my-header3: baz

Config:

remove: ["my-header1", "my-header3"]

Output:

GET /foo HTTP/1.1

my-header2: bar

setRemove

public void setRemove(List<String> remove)

Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

Input:

GET /foo HTTP/1.1

my-header1: foo

my-header2: bar

my-header3: baz

Config:

remove: ["my-header1", "my-header3"]

Output:

GET /foo HTTP/1.1

my-header2: bar

getSet

public List<HTTPHeader> getSet()

Set overwrites the request with the given header (name, value) before the action.

Input:

GET /foo HTTP/1.1

my-header: foo

Config:

set:

- name: "my-header"

value: "bar"

Output:

GET /foo HTTP/1.1

my-header: bar

setSet

public void setSet(List<HTTPHeader> set)

Set overwrites the request with the given header (name, value) before the action.

Input:

GET /foo HTTP/1.1

my-header: foo

Config:

set:

- name: "my-header"

value: "bar"

Output:

GET /foo HTTP/1.1

my-header: bar

edit

public HTTPHeaderFilterBuilder edit()

Specified by:

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

toBuilder

public HTTPHeaderFilterBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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