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

Class HTTPHeaderMatch

java.lang.Object

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

All Implemented Interfaces:

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

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

HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTTPHeaderMatch()	No args constructor for use in serialization
HTTPHeaderMatch(String name, String type, String value)

Method Summary

Modifier and Type	Method	Description
HTTPHeaderMatchBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getName()	Name is the name of the HTTP Header to be matched.
String	getType()	Type specifies how to match against the value of the header.
String	getValue()	Value is the value of HTTP Header to be matched.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setName(String name)	Name is the name of the HTTP Header to be matched.
void	setType(String type)	Type specifies how to match against the value of the header.
void	setValue(String value)	Value is the value of HTTP Header to be matched.
HTTPHeaderMatchBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPHeaderMatch

public HTTPHeaderMatch()

No args constructor for use in serialization

HTTPHeaderMatch

public HTTPHeaderMatch(String name,
                       String type,
                       String value)

Method Detail

getName

public String getName()

Name is the name of the HTTP Header to be matched. Name matching MUST be case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).

If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.

When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie".

setName

public void setName(String name)

Name is the name of the HTTP Header to be matched. Name matching MUST be case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).

If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.

When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie".

getType

public String getType()

Type specifies how to match against the value of the header.

Support: Core (Exact)

Support: Implementation-specific (RegularExpression)

Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.

setType

public void setType(String type)

Type specifies how to match against the value of the header.

Support: Core (Exact)

Support: Implementation-specific (RegularExpression)

Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.

getValue

public String getValue()

Value is the value of HTTP Header to be matched.

setValue

public void setValue(String value)

Value is the value of HTTP Header to be matched.

edit

public HTTPHeaderMatchBuilder edit()

Specified by:

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

toBuilder

public HTTPHeaderMatchBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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