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

Class HTTPExternalAuthFilter

java.lang.Object

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

All Implemented Interfaces:

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

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

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTTPExternalAuthFilter()	No args constructor for use in serialization
HTTPExternalAuthFilter(BackendObjectReference backendRef, ForwardBodyConfig forwardBody, GRPCAuthConfig grpc, HTTPAuthConfig http, String protocol)

Method Summary

Modifier and Type	Method	Description
HTTPExternalAuthFilterBuilder	edit()
Map<String,Object>	getAdditionalProperties()
BackendObjectReference	getBackendRef()	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
ForwardBodyConfig	getForwardBody()	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
GRPCAuthConfig	getGrpc()	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
HTTPAuthConfig	getHttp()	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
String	getProtocol()	ExternalAuthProtocol describes which protocol to use when communicating with an ext_authz authorization server.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setBackendRef(BackendObjectReference backendRef)	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
void	setForwardBody(ForwardBodyConfig forwardBody)	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
void	setGrpc(GRPCAuthConfig grpc)	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
void	setHttp(HTTPAuthConfig http)	HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.
void	setProtocol(String protocol)	ExternalAuthProtocol describes which protocol to use when communicating with an ext_authz authorization server.
HTTPExternalAuthFilterBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPExternalAuthFilter

public HTTPExternalAuthFilter()

No args constructor for use in serialization

HTTPExternalAuthFilter

public HTTPExternalAuthFilter(BackendObjectReference backendRef,
                              ForwardBodyConfig forwardBody,
                              GRPCAuthConfig grpc,
                              HTTPAuthConfig http,
                              String protocol)

Method Detail

getBackendRef

public BackendObjectReference getBackendRef()

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

setBackendRef

public void setBackendRef(BackendObjectReference backendRef)

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

getForwardBody

public ForwardBodyConfig getForwardBody()

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

setForwardBody

public void setForwardBody(ForwardBodyConfig forwardBody)

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

getGrpc

public GRPCAuthConfig getGrpc()

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

setGrpc

public void setGrpc(GRPCAuthConfig grpc)

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

getHttp

public HTTPAuthConfig getHttp()

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

setHttp

public void setHttp(HTTPAuthConfig http)

HTTPExternalAuthFilter defines a filter that modifies requests by sending request details to an external authorization server.

Support: Extended Feature Name: HTTPRouteExternalAuth

getProtocol

public String getProtocol()

ExternalAuthProtocol describes which protocol to use when communicating with an ext_authz authorization server.

When this is set to GRPC, each backend must use the Envoy ext_authz protocol on the port specified in `backendRefs`. Requests and responses are defined in the protobufs explained at: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto

When this is set to HTTP, each backend must respond with a `200` status code in on a successful authorization. Any other code is considered an authorization failure.

Feature Names: GRPC Support - HTTPRouteExternalAuthGRPC HTTP Support - HTTPRouteExternalAuthHTTP

setProtocol

public void setProtocol(String protocol)

ExternalAuthProtocol describes which protocol to use when communicating with an ext_authz authorization server.

When this is set to GRPC, each backend must use the Envoy ext_authz protocol on the port specified in `backendRefs`. Requests and responses are defined in the protobufs explained at: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto

When this is set to HTTP, each backend must respond with a `200` status code in on a successful authorization. Any other code is considered an authorization failure.

Feature Names: GRPC Support - HTTPRouteExternalAuthGRPC HTTP Support - HTTPRouteExternalAuthHTTP

edit

public HTTPExternalAuthFilterBuilder edit()

Specified by:

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

toBuilder

public HTTPExternalAuthFilterBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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