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

Class HTTPQueryParamMatch

java.lang.Object

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

All Implemented Interfaces:

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

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

HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HTTPQueryParamMatchBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getName()	Name is the name of the HTTP query param to be matched.
String	getType()	Type specifies how to match against the value of the query parameter.
String	getValue()	Value is the value of HTTP query param 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 query param to be matched.
void	setType(String type)	Type specifies how to match against the value of the query parameter.
void	setValue(String value)	Value is the value of HTTP query param to be matched.
HTTPQueryParamMatchBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPQueryParamMatch

public HTTPQueryParamMatch()

No args constructor for use in serialization

HTTPQueryParamMatch

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

Method Detail

getName

public String getName()

Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).

If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored.

If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is *recommended* that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API.

Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations.

setName

public void setName(String name)

Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).

If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored.

If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is *recommended* that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API.

Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations.

getType

public String getType()

Type specifies how to match against the value of the query parameter.

Support: Extended (Exact)

Support: Implementation-specific (RegularExpression)

Since RegularExpression QueryParamMatchType 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 query parameter.

Support: Extended (Exact)

Support: Implementation-specific (RegularExpression)

Since RegularExpression QueryParamMatchType 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 query param to be matched.

setValue

public void setValue(String value)

Value is the value of HTTP query param to be matched.

edit

public HTTPQueryParamMatchBuilder edit()

Specified by:

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

toBuilder

public HTTPQueryParamMatchBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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