Enum HttpRouteFilter

pub enum HttpRouteFilter {
    RequestHeaderModifier {
        request_header_modifier: HttpRequestHeaderFilter,
    },
    ResponseHeaderModifier {
        response_header_modifier: HttpRequestHeaderFilter,
    },
    RequestMirror {
        request_mirror: HttpRequestMirrorFilter,
    },
    RequestRedirect {
        request_redirect: HttpRequestRedirectFilter,
    },
    URLRewrite {
        url_rewrite: HttpUrlRewriteFilter,
    },
    ExtensionRef {
        extension_ref: LocalObjectReference,
    },
}

HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.

Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:

• Core: Filter types and their corresponding configuration defined by “Support: Core” in this package, e.g. “RequestHeaderModifier”. All implementations must support core filters.

• Extended: Filter types and their corresponding configuration defined by “Support: Extended” in this package, e.g. “RequestMirror”. Implementers are encouraged to support extended filters.

• Custom: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field. Type should be set to “ExtensionRef” for custom filters.

Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.

If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.

Variants

RequestHeaderModifier

RequestHeaderModifier defines a schema for a filter that modifies request headers.

Support: Core

Fields

request_header_modifier: HttpRequestHeaderFilter

ResponseHeaderModifier

ResponseHeaderModifier defines a schema for a filter that modifies response headers.

Support: Extended

Fields

response_header_modifier: HttpRequestHeaderFilter

RequestMirror

RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored.

Support: Extended

Fields

request_mirror: HttpRequestMirrorFilter

RequestRedirect

RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection.

Support: Core

Fields

request_redirect: HttpRequestRedirectFilter

URLRewrite

URLRewrite defines a schema for a filter that modifies a request during forwarding.

Support: Extended

Fields

url_rewrite: HttpUrlRewriteFilter

ExtensionRef

ExtensionRef is an optional, implementation-specific extension to the “filter” behavior. For example, resource “myroutefilter” in group “networking.example.net”). ExtensionRef MUST NOT be used for core and extended filters.

Support: Implementation-specific

Fields

extension_ref: LocalObjectReference

Trait Implementations

impl Clone for HttpRouteFilter

fn clone(&self) -> HttpRouteFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpRouteFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpRouteFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GrpcRouteFilter> for HttpRouteFilter

fn from(filter: GrpcRouteFilter) -> Self

Converts to this type from the input type.

impl JsonSchema for HttpRouteFilter

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for HttpRouteFilter

fn eq(&self, other: &HttpRouteFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HttpRouteFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HttpRouteFilter

impl StructuralPartialEq for HttpRouteFilter