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

Class HTTPPathModifier

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<HTTPPathModifierBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HTTPPathModifier
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HTTPPathModifierBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    HTTPPathModifier defines configuration for path modifiers. <gateway:experimental>
    See Also:
    Serialized Form

    • Constructor Detail

      • HTTPPathModifier

        public HTTPPathModifier()
        No args constructor for use in serialization

      • HTTPPathModifier

        public HTTPPathModifier​(String replaceFullPath,
                        String replacePrefixMatch,
                        String type)

    • Method Detail

      • getReplaceFullPath

        public String getReplaceFullPath()
        ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.

      • setReplaceFullPath

        public void setReplaceFullPath​(String replaceFullPath)
        ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.

      • getReplacePrefixMatch

        public String getReplacePrefixMatch()
        ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".


        Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not.


        ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`.


        Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | <empty string> | /bar /foo/ | /foo | <empty string> | / /foo | /foo | <empty string> | / /foo/ | /foo | / | / /foo | /foo | / | /

      • setReplacePrefixMatch

        public void setReplacePrefixMatch​(String replacePrefixMatch)
        ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".


        Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not.


        ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`.


        Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | <empty string> | /bar /foo/ | /foo | <empty string> | / /foo | /foo | <empty string> | / /foo/ | /foo | / | / /foo | /foo | / | /

      • getType

        public String getType()
        Type defines the type of path modifier. Additional types may be added in a future release of the API.


        Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.


        Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

      • setType

        public void setType​(String type)
        Type defines the type of path modifier. Additional types may be added in a future release of the API.


        Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.


        Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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