Package io.fabric8.openshift.api.model.operator.v1

Class IngressControllerHTTPHeaders

java.lang.Object

io.fabric8.openshift.api.model.operator.v1.IngressControllerHTTPHeaders

All Implemented Interfaces:

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

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

IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IngressControllerHTTPHeaders()	No args constructor for use in serialization
IngressControllerHTTPHeaders(IngressControllerHTTPHeaderActions actions, String forwardedHeaderPolicy, List<String> headerNameCaseAdjustments, IngressControllerHTTPUniqueIdHeaderPolicy uniqueId)

Method Summary

Modifier and Type	Method	Description
IngressControllerHTTPHeadersBuilder	edit()
IngressControllerHTTPHeaderActions	getActions()	IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.
Map<String,Object>	getAdditionalProperties()
String	getForwardedHeaderPolicy()	forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers.
List<String>	getHeaderNameCaseAdjustments()	headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names.
IngressControllerHTTPUniqueIdHeaderPolicy	getUniqueId()	IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.
void	setActions(IngressControllerHTTPHeaderActions actions)	IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setForwardedHeaderPolicy(String forwardedHeaderPolicy)	forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers.
void	setHeaderNameCaseAdjustments(List<String> headerNameCaseAdjustments)	headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names.
void	setUniqueId(IngressControllerHTTPUniqueIdHeaderPolicy uniqueId)	IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.
IngressControllerHTTPHeadersBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

IngressControllerHTTPHeaders

public IngressControllerHTTPHeaders()

No args constructor for use in serialization

IngressControllerHTTPHeaders

public IngressControllerHTTPHeaders(IngressControllerHTTPHeaderActions actions,
                                    String forwardedHeaderPolicy,
                                    List<String> headerNameCaseAdjustments,
                                    IngressControllerHTTPUniqueIdHeaderPolicy uniqueId)

Method Detail

getActions

public IngressControllerHTTPHeaderActions getActions()

IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.

setActions

public void setActions(IngressControllerHTTPHeaderActions actions)

IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.

getForwardedHeaderPolicy

public String getForwardedHeaderPolicy()

forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers. The value may be one of the following:

* "Append", which specifies that the IngressController appends the

headers, preserving existing headers.

* "Replace", which specifies that the IngressController sets the

headers, replacing any existing Forwarded or X-Forwarded-* headers.

* "IfNone", which specifies that the IngressController sets the

headers if they are not already set.

* "Never", which specifies that the IngressController never sets the

headers, preserving any existing headers.

By default, the policy is "Append".

setForwardedHeaderPolicy

public void setForwardedHeaderPolicy(String forwardedHeaderPolicy)

forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers. The value may be one of the following:

* "Append", which specifies that the IngressController appends the

headers, preserving existing headers.

* "Replace", which specifies that the IngressController sets the

headers, replacing any existing Forwarded or X-Forwarded-* headers.

* "IfNone", which specifies that the IngressController sets the

headers if they are not already set.

* "Never", which specifies that the IngressController never sets the

headers, preserving any existing headers.

By default, the policy is "Append".

getHeaderNameCaseAdjustments

public List<String> getHeaderNameCaseAdjustments()

headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names. Each adjustment is specified as an HTTP header name with the desired capitalization. For example, specifying "X-Forwarded-For" indicates that the "x-forwarded-for" HTTP header should be adjusted to have the specified capitalization.

These adjustments are only applied to cleartext, edge-terminated, and re-encrypt routes, and only when using HTTP/1.

For request headers, these adjustments are applied only for routes that have the haproxy.router.openshift.io/h1-adjust-case=true annotation. For response headers, these adjustments are applied to all HTTP responses.

If this field is empty, no request headers are adjusted.

setHeaderNameCaseAdjustments

public void setHeaderNameCaseAdjustments(List<String> headerNameCaseAdjustments)

headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names. Each adjustment is specified as an HTTP header name with the desired capitalization. For example, specifying "X-Forwarded-For" indicates that the "x-forwarded-for" HTTP header should be adjusted to have the specified capitalization.

These adjustments are only applied to cleartext, edge-terminated, and re-encrypt routes, and only when using HTTP/1.

For request headers, these adjustments are applied only for routes that have the haproxy.router.openshift.io/h1-adjust-case=true annotation. For response headers, these adjustments are applied to all HTTP responses.

If this field is empty, no request headers are adjusted.

getUniqueId

public IngressControllerHTTPUniqueIdHeaderPolicy getUniqueId()

IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.

setUniqueId

public void setUniqueId(IngressControllerHTTPUniqueIdHeaderPolicy uniqueId)

IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.

edit

public IngressControllerHTTPHeadersBuilder edit()

Specified by:

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

toBuilder

public IngressControllerHTTPHeadersBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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