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

Class HTTPRouteRule

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<HTTPRouteRuleBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HTTPRouteRule
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HTTPRouteRuleBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).
    See Also:
    Serialized Form

    • Method Detail

      • getBackendRefs

        public List<HTTPBackendRef> getBackendRefs()
        BackendRefs defines the backend(s) where matching requests should be sent.


        Failure behavior here depends on how many BackendRefs are specified and how many are invalid.


        If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive a 500 status code.


        See the HTTPBackendRef definition for the rules about what makes a single HTTPBackendRef invalid.


        When a HTTPBackendRef is invalid, 500 status codes MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive a 500 status code.


        For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic must receive a 500. Implementations may choose how that 50 percent is determined.


        When a HTTPBackendRef refers to a Service that has no ready endpoints, implementations SHOULD return a 503 for requests to that backend instead. If an implementation chooses to do this, all of the above rules for 500 responses MUST also apply for responses that return a 503.


        Support: Core for Kubernetes Service


        Support: Extended for Kubernetes ServiceImport


        Support: Implementation-specific for any other resource


        Support for weight: Core

      • setBackendRefs

        public void setBackendRefs​(List<HTTPBackendRef> backendRefs)
        BackendRefs defines the backend(s) where matching requests should be sent.


        Failure behavior here depends on how many BackendRefs are specified and how many are invalid.


        If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive a 500 status code.


        See the HTTPBackendRef definition for the rules about what makes a single HTTPBackendRef invalid.


        When a HTTPBackendRef is invalid, 500 status codes MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive a 500 status code.


        For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic must receive a 500. Implementations may choose how that 50 percent is determined.


        When a HTTPBackendRef refers to a Service that has no ready endpoints, implementations SHOULD return a 503 for requests to that backend instead. If an implementation chooses to do this, all of the above rules for 500 responses MUST also apply for responses that return a 503.


        Support: Core for Kubernetes Service


        Support: Extended for Kubernetes ServiceImport


        Support: Implementation-specific for any other resource


        Support for weight: Core

      • getFilters

        public List<HTTPRouteFilter> getFilters()
        Filters define the filters that are applied to requests that match this rule.


        Wherever possible, implementations SHOULD implement filters in the order they are specified.


        Implementations MAY choose to implement this ordering strictly, rejecting any combination or order of filters that can not be supported. If implementations choose a strict interpretation of filter ordering, they MUST clearly document that behavior.


        To reject an invalid combination or order of filters, implementations SHOULD consider the Route Rules with this configuration invalid. If all Route Rules in a Route are invalid, the entire Route would be considered invalid. If only a portion of Route Rules are invalid, implementations MUST set the "PartiallyInvalid" condition for the Route.


        Conformance-levels at this level are defined based on the type of filter:


        - ALL core filters MUST be supported by all implementations. - Implementers are encouraged to support extended filters. - Implementation-specific custom filters have no API guarantees across

        implementations.


        Specifying the same filter multiple times is not supported unless explicitly indicated in the filter.


        All filters are expected to be compatible with each other except for the URLRewrite and RequestRedirect filters, which may not be combined. If an implementation can not support other combinations of filters, they must clearly document that limitation. In cases where incompatible or unsupported filters are specified and cause the `Accepted` condition to be set to status `False`, implementations may use the `IncompatibleFilters` reason to specify this configuration error.


        Support: Core

      • setFilters

        public void setFilters​(List<HTTPRouteFilter> filters)
        Filters define the filters that are applied to requests that match this rule.


        Wherever possible, implementations SHOULD implement filters in the order they are specified.


        Implementations MAY choose to implement this ordering strictly, rejecting any combination or order of filters that can not be supported. If implementations choose a strict interpretation of filter ordering, they MUST clearly document that behavior.


        To reject an invalid combination or order of filters, implementations SHOULD consider the Route Rules with this configuration invalid. If all Route Rules in a Route are invalid, the entire Route would be considered invalid. If only a portion of Route Rules are invalid, implementations MUST set the "PartiallyInvalid" condition for the Route.


        Conformance-levels at this level are defined based on the type of filter:


        - ALL core filters MUST be supported by all implementations. - Implementers are encouraged to support extended filters. - Implementation-specific custom filters have no API guarantees across

        implementations.


        Specifying the same filter multiple times is not supported unless explicitly indicated in the filter.


        All filters are expected to be compatible with each other except for the URLRewrite and RequestRedirect filters, which may not be combined. If an implementation can not support other combinations of filters, they must clearly document that limitation. In cases where incompatible or unsupported filters are specified and cause the `Accepted` condition to be set to status `False`, implementations may use the `IncompatibleFilters` reason to specify this configuration error.


        Support: Core

      • getMatches

        public List<HTTPRouteMatch> getMatches()
        Matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied.


        For example, take the following matches configuration:


        ``` matches: - path:

        value: "/foo"

        headers:

        - name: "version"

        value: "v2"

        - path:

        value: "/v2/foo"

        ```


        For a request to match against this rule, a request must satisfy EITHER of the two conditions:


        - path prefixed with `/foo` AND contains the header `version: v2` - path prefix of `/v2/foo`


        See the documentation for HTTPRouteMatch on how to specify multiple match conditions that should be ANDed together.


        If no matches are specified, the default is a prefix path match on "/", which has the effect of matching every HTTP request.


        Proxy or Load Balancer routing configuration generated from HTTPRoutes MUST prioritize matches based on the following criteria, continuing on ties. Across all rules specified on applicable Routes, precedence must be given to the match having:


        * "Exact" path match. * "Prefix" path match with largest number of characters. * Method match. * Largest number of header matches. * Largest number of query param matches.


        Note: The precedence of RegularExpression path matches are implementation-specific.


        If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties:


        * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by

        "{namespace}/{name}".


        If ties still exist within an HTTPRoute, matching precedence MUST be granted to the FIRST matching rule (in list order) with a match meeting the above criteria.


        When no rules matching a request have been successfully attached to the parent a request is coming from, a HTTP 404 status code MUST be returned.

      • setMatches

        public void setMatches​(List<HTTPRouteMatch> matches)
        Matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied.


        For example, take the following matches configuration:


        ``` matches: - path:

        value: "/foo"

        headers:

        - name: "version"

        value: "v2"

        - path:

        value: "/v2/foo"

        ```


        For a request to match against this rule, a request must satisfy EITHER of the two conditions:


        - path prefixed with `/foo` AND contains the header `version: v2` - path prefix of `/v2/foo`


        See the documentation for HTTPRouteMatch on how to specify multiple match conditions that should be ANDed together.


        If no matches are specified, the default is a prefix path match on "/", which has the effect of matching every HTTP request.


        Proxy or Load Balancer routing configuration generated from HTTPRoutes MUST prioritize matches based on the following criteria, continuing on ties. Across all rules specified on applicable Routes, precedence must be given to the match having:


        * "Exact" path match. * "Prefix" path match with largest number of characters. * Method match. * Largest number of header matches. * Largest number of query param matches.


        Note: The precedence of RegularExpression path matches are implementation-specific.


        If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties:


        * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by

        "{namespace}/{name}".


        If ties still exist within an HTTPRoute, matching precedence MUST be granted to the FIRST matching rule (in list order) with a match meeting the above criteria.


        When no rules matching a request have been successfully attached to the parent a request is coming from, a HTTP 404 status code MUST be returned.

      • getName

        public String getName()
        Name is the name of the route rule. This name MUST be unique within a Route if it is set.


        Support: Extended <gateway:experimental>

      • setName

        public void setName​(String name)
        Name is the name of the route rule. This name MUST be unique within a Route if it is set.


        Support: Extended <gateway:experimental>

      • getRetry

        public HTTPRouteRetry getRetry()
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • setRetry

        public void setRetry​(HTTPRouteRetry retry)
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • getSessionPersistence

        public SessionPersistence getSessionPersistence()
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • setSessionPersistence

        public void setSessionPersistence​(SessionPersistence sessionPersistence)
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • getTimeouts

        public HTTPRouteTimeouts getTimeouts()
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • setTimeouts

        public void setTimeouts​(HTTPRouteTimeouts timeouts)
        HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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