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

Class GRPCRouteFilter

java.lang.Object

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

All Implemented Interfaces:

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

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

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GRPCRouteFilter()	No args constructor for use in serialization
GRPCRouteFilter(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef, HTTPHeaderFilter requestHeaderModifier, HTTPRequestMirrorFilter requestMirror, HTTPHeaderFilter responseHeaderModifier, String type)

Method Summary

Modifier and Type	Method	Description
GRPCRouteFilterBuilder	edit()
Map<String,Object>	getAdditionalProperties()
io.fabric8.kubernetes.api.model.LocalObjectReference	getExtensionRef()	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPHeaderFilter	getRequestHeaderModifier()	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPRequestMirrorFilter	getRequestMirror()	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPHeaderFilter	getResponseHeaderModifier()	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
String	getType()	Type identifies the type of filter to apply.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setExtensionRef(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef)	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setRequestHeaderModifier(HTTPHeaderFilter requestHeaderModifier)	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setRequestMirror(HTTPRequestMirrorFilter requestMirror)	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setResponseHeaderModifier(HTTPHeaderFilter responseHeaderModifier)	GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
void	setType(String type)	Type identifies the type of filter to apply.
GRPCRouteFilterBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

GRPCRouteFilter

public GRPCRouteFilter()

No args constructor for use in serialization

GRPCRouteFilter

public GRPCRouteFilter(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef,
                       HTTPHeaderFilter requestHeaderModifier,
                       HTTPRequestMirrorFilter requestMirror,
                       HTTPHeaderFilter responseHeaderModifier,
                       String type)

Method Detail

getExtensionRef

public io.fabric8.kubernetes.api.model.LocalObjectReference getExtensionRef()

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

setExtensionRef

public void setExtensionRef(io.fabric8.kubernetes.api.model.LocalObjectReference extensionRef)

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

getRequestHeaderModifier

public HTTPHeaderFilter getRequestHeaderModifier()

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

setRequestHeaderModifier

public void setRequestHeaderModifier(HTTPHeaderFilter requestHeaderModifier)

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

getRequestMirror

public HTTPRequestMirrorFilter getRequestMirror()

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

setRequestMirror

public void setRequestMirror(HTTPRequestMirrorFilter requestMirror)

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

getResponseHeaderModifier

public HTTPHeaderFilter getResponseHeaderModifier()

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

setResponseHeaderModifier

public void setResponseHeaderModifier(HTTPHeaderFilter responseHeaderModifier)

GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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.

getType

public String getType()

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 supporting GRPCRoute 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.

- Implementation-specific: 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` MUST 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.

<gateway:experimental:validation:Enum=ResponseHeaderModifier;RequestHeaderModifier;RequestMirror;ExtensionRef>

setType

public void setType(String type)

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 supporting GRPCRoute 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.

- Implementation-specific: 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` MUST 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.

<gateway:experimental:validation:Enum=ResponseHeaderModifier;RequestHeaderModifier;RequestMirror;ExtensionRef>

edit

public GRPCRouteFilterBuilder edit()

Specified by:

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

toBuilder

public GRPCRouteFilterBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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