java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3.ExtAuthz.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtAuthzOrBuilder, Cloneable

Enclosing class:: ExtAuthz

public static final class ExtAuthz.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder> implements ExtAuthzOrBuilder

 [#next-free-field: 32]

Protobuf type envoy.extensions.filters.http.ext_authz.v3.ExtAuthz

Method Summary

Modifier and Type

Method

Description

ExtAuthz.Builder

addAllMetadataContextNamespaces(Iterable<String> values)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

addAllRouteMetadataContextNamespaces(Iterable<String> values)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addAllRouteTypedMetadataContextNamespaces(Iterable<String> values)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addAllTypedMetadataContextNamespaces(Iterable<String> values)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

addMetadataContextNamespaces(String value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

addMetadataContextNamespacesBytes(com.google.protobuf.ByteString value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)

ExtAuthz.Builder

addRouteMetadataContextNamespaces(String value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addRouteMetadataContextNamespacesBytes(com.google.protobuf.ByteString value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addRouteTypedMetadataContextNamespaces(String value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addRouteTypedMetadataContextNamespacesBytes(com.google.protobuf.ByteString value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

addTypedMetadataContextNamespaces(String value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

addTypedMetadataContextNamespacesBytes(com.google.protobuf.ByteString value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz

build()

ExtAuthz

buildPartial()

ExtAuthz.Builder

clear()

ExtAuthz.Builder

clearAllowedHeaders()

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ExtAuthz.Builder

clearBootstrapMetadataLabelsKey()

Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.

ExtAuthz.Builder

clearChargeClusterResponseStats()

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

ExtAuthz.Builder

clearClearRouteCache()

Clears the route cache in order to allow the external authorization service to correctly affect routing decisions.

ExtAuthz.Builder

clearDecoderHeaderMutationRules()

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

ExtAuthz.Builder

clearDenyAtDisable()

Specifies whether to deny the requests when the filter is disabled.

ExtAuthz.Builder

clearDisallowedHeaders()

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ExtAuthz.Builder

clearEmitFilterStateStats()

When set to ``true``, the filter will emit per-stream stats for access logging.

ExtAuthz.Builder

clearEnableDynamicMetadataIngestion()

Enable or disable ingestion of dynamic metadata from the ext_authz service.

ExtAuthz.Builder

clearEncodeRawHeaders()

Whether to encode the raw headers (i.e., unsanitized values and unconcatenated multi-line headers) in the authorization request.

ExtAuthz.Builder

clearEnforceResponseHeaderLimits()

When set to ``true``, the filter will enforce the response header map's count and size limits by sending a local reply when those limits are violated.

ExtAuthz.Builder

clearFailureModeAllow()

Changes the filter's behavior on errors: * When set to ``true``, the filter will ``accept`` the client request even if communication with the authorization service has failed, or if the authorization service has returned an HTTP 5xx error

ExtAuthz.Builder

clearFailureModeAllowHeaderAdd()

When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``, ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error.

ExtAuthz.Builder

clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

ExtAuthz.Builder

clearFilterEnabled()

Specifies if the filter is enabled.

ExtAuthz.Builder

clearFilterEnabledMetadata()

Specifies if the filter is enabled with metadata matcher.

ExtAuthz.Builder

clearFilterMetadata()

Additional metadata to be added to the filter state for logging purposes.

ExtAuthz.Builder

clearGrpcService()

gRPC service configuration (default timeout: 200ms).

ExtAuthz.Builder

clearHttpService()

HTTP service configuration (default timeout: 200ms).

ExtAuthz.Builder

clearIncludePeerCertificate()

Specifies if the peer certificate is sent to the external service.

ExtAuthz.Builder

clearIncludeTlsSession()

Specifies if the TLS session level details like SNI are sent to the external service.

ExtAuthz.Builder

clearMaxDeniedResponseBodyBytes()

Sets the maximum size (in bytes) of the response body that the filter will send downstream when a request is denied by the external authorization service.

ExtAuthz.Builder

clearMetadataContextNamespaces()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

ExtAuthz.Builder

clearRouteMetadataContextNamespaces()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

clearRouteTypedMetadataContextNamespaces()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

clearServices()

ExtAuthz.Builder

clearStatPrefix()

Optional additional prefix to use when emitting statistics.

ExtAuthz.Builder

clearStatusOnError()

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

ExtAuthz.Builder

clearTransportApiVersion()

API version for ext_authz transport protocol.

ExtAuthz.Builder

clearTypedMetadataContextNamespaces()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

clearValidateMutations()

When set to ``true``, the filter will check the :ref:`ext_authz response <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and query parameter mutations.

ExtAuthz.Builder

clearWithRequestBody()

Enables the filter to buffer the client request body and send it within the authorization request.

ExtAuthz.Builder

clone()

ListStringMatcher

getAllowedHeaders()

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ListStringMatcher.Builder

getAllowedHeadersBuilder()

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ListStringMatcherOrBuilder

getAllowedHeadersOrBuilder()

Check request to authorization server will include the client request headers that have a correspondent match in the list.

String

getBootstrapMetadataLabelsKey()

Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.

com.google.protobuf.ByteString

getBootstrapMetadataLabelsKeyBytes()

Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.

com.google.protobuf.BoolValue

getChargeClusterResponseStats()

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

com.google.protobuf.BoolValue.Builder

getChargeClusterResponseStatsBuilder()

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

com.google.protobuf.BoolValueOrBuilder

getChargeClusterResponseStatsOrBuilder()

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

boolean

getClearRouteCache()

Clears the route cache in order to allow the external authorization service to correctly affect routing decisions.

HeaderMutationRules

getDecoderHeaderMutationRules()

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

HeaderMutationRules.Builder

getDecoderHeaderMutationRulesBuilder()

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

HeaderMutationRulesOrBuilder

getDecoderHeaderMutationRulesOrBuilder()

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

ExtAuthz

getDefaultInstanceForType()

RuntimeFeatureFlag

getDenyAtDisable()

Specifies whether to deny the requests when the filter is disabled.

RuntimeFeatureFlag.Builder

getDenyAtDisableBuilder()

Specifies whether to deny the requests when the filter is disabled.

RuntimeFeatureFlagOrBuilder

getDenyAtDisableOrBuilder()

Specifies whether to deny the requests when the filter is disabled.

static final com.google.protobuf.Descriptors.Descriptor

getDescriptor()

com.google.protobuf.Descriptors.Descriptor

getDescriptorForType()

ListStringMatcher

getDisallowedHeaders()

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ListStringMatcher.Builder

getDisallowedHeadersBuilder()

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ListStringMatcherOrBuilder

getDisallowedHeadersOrBuilder()

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

boolean

getEmitFilterStateStats()

When set to ``true``, the filter will emit per-stream stats for access logging.

com.google.protobuf.BoolValue

getEnableDynamicMetadataIngestion()

Enable or disable ingestion of dynamic metadata from the ext_authz service.

com.google.protobuf.BoolValue.Builder

getEnableDynamicMetadataIngestionBuilder()

Enable or disable ingestion of dynamic metadata from the ext_authz service.

com.google.protobuf.BoolValueOrBuilder

getEnableDynamicMetadataIngestionOrBuilder()

Enable or disable ingestion of dynamic metadata from the ext_authz service.

boolean

getEncodeRawHeaders()

Whether to encode the raw headers (i.e., unsanitized values and unconcatenated multi-line headers) in the authorization request.

boolean

getEnforceResponseHeaderLimits()

When set to ``true``, the filter will enforce the response header map's count and size limits by sending a local reply when those limits are violated.

boolean

getFailureModeAllow()

Changes the filter's behavior on errors: * When set to ``true``, the filter will ``accept`` the client request even if communication with the authorization service has failed, or if the authorization service has returned an HTTP 5xx error

boolean

getFailureModeAllowHeaderAdd()

When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``, ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error.

RuntimeFractionalPercent

getFilterEnabled()

Specifies if the filter is enabled.

RuntimeFractionalPercent.Builder

getFilterEnabledBuilder()

Specifies if the filter is enabled.

MetadataMatcher

getFilterEnabledMetadata()

Specifies if the filter is enabled with metadata matcher.

MetadataMatcher.Builder

getFilterEnabledMetadataBuilder()

Specifies if the filter is enabled with metadata matcher.

MetadataMatcherOrBuilder

getFilterEnabledMetadataOrBuilder()

Specifies if the filter is enabled with metadata matcher.

RuntimeFractionalPercentOrBuilder

getFilterEnabledOrBuilder()

Specifies if the filter is enabled.

com.google.protobuf.Struct

getFilterMetadata()

Additional metadata to be added to the filter state for logging purposes.

com.google.protobuf.Struct.Builder

getFilterMetadataBuilder()

Additional metadata to be added to the filter state for logging purposes.

com.google.protobuf.StructOrBuilder

getFilterMetadataOrBuilder()

Additional metadata to be added to the filter state for logging purposes.

GrpcService

getGrpcService()

gRPC service configuration (default timeout: 200ms).

GrpcService.Builder

getGrpcServiceBuilder()

gRPC service configuration (default timeout: 200ms).

GrpcServiceOrBuilder

getGrpcServiceOrBuilder()

gRPC service configuration (default timeout: 200ms).

HttpService

getHttpService()

HTTP service configuration (default timeout: 200ms).

HttpService.Builder

getHttpServiceBuilder()

HTTP service configuration (default timeout: 200ms).

HttpServiceOrBuilder

getHttpServiceOrBuilder()

HTTP service configuration (default timeout: 200ms).

boolean

getIncludePeerCertificate()

Specifies if the peer certificate is sent to the external service.

boolean

getIncludeTlsSession()

Specifies if the TLS session level details like SNI are sent to the external service.

int

getMaxDeniedResponseBodyBytes()

Sets the maximum size (in bytes) of the response body that the filter will send downstream when a request is denied by the external authorization service.

String

getMetadataContextNamespaces(int index)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

com.google.protobuf.ByteString

getMetadataContextNamespacesBytes(int index)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

int

getMetadataContextNamespacesCount()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

com.google.protobuf.ProtocolStringList

getMetadataContextNamespacesList()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

String

getRouteMetadataContextNamespaces(int index)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

com.google.protobuf.ByteString

getRouteMetadataContextNamespacesBytes(int index)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

int

getRouteMetadataContextNamespacesCount()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

com.google.protobuf.ProtocolStringList

getRouteMetadataContextNamespacesList()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

String

getRouteTypedMetadataContextNamespaces(int index)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

com.google.protobuf.ByteString

getRouteTypedMetadataContextNamespacesBytes(int index)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

int

getRouteTypedMetadataContextNamespacesCount()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

com.google.protobuf.ProtocolStringList

getRouteTypedMetadataContextNamespacesList()

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.ServicesCase

getServicesCase()

String

getStatPrefix()

Optional additional prefix to use when emitting statistics.

com.google.protobuf.ByteString

getStatPrefixBytes()

Optional additional prefix to use when emitting statistics.

HttpStatus

getStatusOnError()

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

HttpStatus.Builder

getStatusOnErrorBuilder()

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

HttpStatusOrBuilder

getStatusOnErrorOrBuilder()

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

ApiVersion

getTransportApiVersion()

API version for ext_authz transport protocol.

int

getTransportApiVersionValue()

API version for ext_authz transport protocol.

String

getTypedMetadataContextNamespaces(int index)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

com.google.protobuf.ByteString

getTypedMetadataContextNamespacesBytes(int index)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

int

getTypedMetadataContextNamespacesCount()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

com.google.protobuf.ProtocolStringList

getTypedMetadataContextNamespacesList()

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

boolean

getValidateMutations()

When set to ``true``, the filter will check the :ref:`ext_authz response <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and query parameter mutations.

BufferSettings

getWithRequestBody()

Enables the filter to buffer the client request body and send it within the authorization request.

BufferSettings.Builder

getWithRequestBodyBuilder()

Enables the filter to buffer the client request body and send it within the authorization request.

BufferSettingsOrBuilder

getWithRequestBodyOrBuilder()

Enables the filter to buffer the client request body and send it within the authorization request.

boolean

hasAllowedHeaders()

Check request to authorization server will include the client request headers that have a correspondent match in the list.

boolean

hasChargeClusterResponseStats()

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

boolean

hasDecoderHeaderMutationRules()

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

boolean

hasDenyAtDisable()

Specifies whether to deny the requests when the filter is disabled.

boolean

hasDisallowedHeaders()

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

boolean

hasEnableDynamicMetadataIngestion()

Enable or disable ingestion of dynamic metadata from the ext_authz service.

boolean

hasFilterEnabled()

Specifies if the filter is enabled.

boolean

hasFilterEnabledMetadata()

Specifies if the filter is enabled with metadata matcher.

boolean

hasFilterMetadata()

Additional metadata to be added to the filter state for logging purposes.

boolean

hasGrpcService()

gRPC service configuration (default timeout: 200ms).

boolean

hasHttpService()

HTTP service configuration (default timeout: 200ms).

boolean

hasStatusOnError()

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

boolean

hasWithRequestBody()

Enables the filter to buffer the client request body and send it within the authorization request.

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

internalGetFieldAccessorTable()

final boolean

isInitialized()

ExtAuthz.Builder

mergeAllowedHeaders(ListStringMatcher value)

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ExtAuthz.Builder

mergeChargeClusterResponseStats(com.google.protobuf.BoolValue value)

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

ExtAuthz.Builder

mergeDecoderHeaderMutationRules(HeaderMutationRules value)

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

ExtAuthz.Builder

mergeDenyAtDisable(RuntimeFeatureFlag value)

Specifies whether to deny the requests when the filter is disabled.

ExtAuthz.Builder

mergeDisallowedHeaders(ListStringMatcher value)

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ExtAuthz.Builder

mergeEnableDynamicMetadataIngestion(com.google.protobuf.BoolValue value)

Enable or disable ingestion of dynamic metadata from the ext_authz service.

ExtAuthz.Builder

mergeFilterEnabled(RuntimeFractionalPercent value)

Specifies if the filter is enabled.

ExtAuthz.Builder

mergeFilterEnabledMetadata(MetadataMatcher value)

Specifies if the filter is enabled with metadata matcher.

ExtAuthz.Builder

mergeFilterMetadata(com.google.protobuf.Struct value)

Additional metadata to be added to the filter state for logging purposes.

ExtAuthz.Builder

mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

ExtAuthz.Builder

mergeFrom(com.google.protobuf.Message other)

ExtAuthz.Builder

mergeFrom(ExtAuthz other)

ExtAuthz.Builder

mergeGrpcService(GrpcService value)

gRPC service configuration (default timeout: 200ms).

ExtAuthz.Builder

mergeHttpService(HttpService value)

HTTP service configuration (default timeout: 200ms).

ExtAuthz.Builder

mergeStatusOnError(HttpStatus value)

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

final ExtAuthz.Builder

mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

ExtAuthz.Builder

mergeWithRequestBody(BufferSettings value)

Enables the filter to buffer the client request body and send it within the authorization request.

ExtAuthz.Builder

setAllowedHeaders(ListStringMatcher value)

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ExtAuthz.Builder

setAllowedHeaders(ListStringMatcher.Builder builderForValue)

Check request to authorization server will include the client request headers that have a correspondent match in the list.

ExtAuthz.Builder

setBootstrapMetadataLabelsKey(String value)

Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.

ExtAuthz.Builder

setBootstrapMetadataLabelsKeyBytes(com.google.protobuf.ByteString value)

Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.

ExtAuthz.Builder

setChargeClusterResponseStats(com.google.protobuf.BoolValue value)

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

ExtAuthz.Builder

setChargeClusterResponseStats(com.google.protobuf.BoolValue.Builder builderForValue)

Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.

ExtAuthz.Builder

setClearRouteCache(boolean value)

Clears the route cache in order to allow the external authorization service to correctly affect routing decisions.

ExtAuthz.Builder

setDecoderHeaderMutationRules(HeaderMutationRules value)

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

ExtAuthz.Builder

setDecoderHeaderMutationRules(HeaderMutationRules.Builder builderForValue)

Rules for what modifications an ext_authz server may make to the request headers before continuing decoding or forwarding upstream.

ExtAuthz.Builder

setDenyAtDisable(RuntimeFeatureFlag value)

Specifies whether to deny the requests when the filter is disabled.

ExtAuthz.Builder

setDenyAtDisable(RuntimeFeatureFlag.Builder builderForValue)

Specifies whether to deny the requests when the filter is disabled.

ExtAuthz.Builder

setDisallowedHeaders(ListStringMatcher value)

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ExtAuthz.Builder

setDisallowedHeaders(ListStringMatcher.Builder builderForValue)

If set, specifically disallow any header in this list to be forwarded to the external authentication server.

ExtAuthz.Builder

setEmitFilterStateStats(boolean value)

When set to ``true``, the filter will emit per-stream stats for access logging.

ExtAuthz.Builder

setEnableDynamicMetadataIngestion(com.google.protobuf.BoolValue value)

Enable or disable ingestion of dynamic metadata from the ext_authz service.

ExtAuthz.Builder

setEnableDynamicMetadataIngestion(com.google.protobuf.BoolValue.Builder builderForValue)

Enable or disable ingestion of dynamic metadata from the ext_authz service.

ExtAuthz.Builder

setEncodeRawHeaders(boolean value)

Whether to encode the raw headers (i.e., unsanitized values and unconcatenated multi-line headers) in the authorization request.

ExtAuthz.Builder

setEnforceResponseHeaderLimits(boolean value)

When set to ``true``, the filter will enforce the response header map's count and size limits by sending a local reply when those limits are violated.

ExtAuthz.Builder

setFailureModeAllow(boolean value)

Changes the filter's behavior on errors: * When set to ``true``, the filter will ``accept`` the client request even if communication with the authorization service has failed, or if the authorization service has returned an HTTP 5xx error

ExtAuthz.Builder

setFailureModeAllowHeaderAdd(boolean value)

When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``, ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error.

ExtAuthz.Builder

setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)

ExtAuthz.Builder

setFilterEnabled(RuntimeFractionalPercent value)

Specifies if the filter is enabled.

ExtAuthz.Builder

setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue)

Specifies if the filter is enabled.

ExtAuthz.Builder

setFilterEnabledMetadata(MetadataMatcher value)

Specifies if the filter is enabled with metadata matcher.

ExtAuthz.Builder

setFilterEnabledMetadata(MetadataMatcher.Builder builderForValue)

Specifies if the filter is enabled with metadata matcher.

ExtAuthz.Builder

setFilterMetadata(com.google.protobuf.Struct value)

Additional metadata to be added to the filter state for logging purposes.

ExtAuthz.Builder

setFilterMetadata(com.google.protobuf.Struct.Builder builderForValue)

Additional metadata to be added to the filter state for logging purposes.

ExtAuthz.Builder

setGrpcService(GrpcService value)

gRPC service configuration (default timeout: 200ms).

ExtAuthz.Builder

setGrpcService(GrpcService.Builder builderForValue)

gRPC service configuration (default timeout: 200ms).

ExtAuthz.Builder

setHttpService(HttpService value)

HTTP service configuration (default timeout: 200ms).

ExtAuthz.Builder

setHttpService(HttpService.Builder builderForValue)

HTTP service configuration (default timeout: 200ms).

ExtAuthz.Builder

setIncludePeerCertificate(boolean value)

Specifies if the peer certificate is sent to the external service.

ExtAuthz.Builder

setIncludeTlsSession(boolean value)

Specifies if the TLS session level details like SNI are sent to the external service.

ExtAuthz.Builder

setMaxDeniedResponseBodyBytes(int value)

Sets the maximum size (in bytes) of the response body that the filter will send downstream when a request is denied by the external authorization service.

ExtAuthz.Builder

setMetadataContextNamespaces(int index, String value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

ExtAuthz.Builder

setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)

ExtAuthz.Builder

setRouteMetadataContextNamespaces(int index, String value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

setRouteTypedMetadataContextNamespaces(int index, String value)

Specifies a list of route metadata namespaces whose values, if present, will be passed to the ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.

ExtAuthz.Builder

setStatPrefix(String value)

Optional additional prefix to use when emitting statistics.

ExtAuthz.Builder

setStatPrefixBytes(com.google.protobuf.ByteString value)

Optional additional prefix to use when emitting statistics.

ExtAuthz.Builder

setStatusOnError(HttpStatus value)

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

ExtAuthz.Builder

setStatusOnError(HttpStatus.Builder builderForValue)

Sets the HTTP status that is returned to the client when the authorization server returns an error or cannot be reached.

ExtAuthz.Builder

setTransportApiVersion(ApiVersion value)

API version for ext_authz transport protocol.

ExtAuthz.Builder

setTransportApiVersionValue(int value)

API version for ext_authz transport protocol.

ExtAuthz.Builder

setTypedMetadataContextNamespaces(int index, String value)

Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.

final ExtAuthz.Builder

setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

ExtAuthz.Builder

setValidateMutations(boolean value)

When set to ``true``, the filter will check the :ref:`ext_authz response <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and query parameter mutations.

ExtAuthz.Builder

setWithRequestBody(BufferSettings value)

Enables the filter to buffer the client request body and send it within the authorization request.

ExtAuthz.Builder

setWithRequestBody(BufferSettings.Builder builderForValue)

Enables the filter to buffer the client request body and send it within the authorization request.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
clear

public ExtAuthz.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
getDefaultInstanceForType

public ExtAuthz getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
build

public ExtAuthz build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder
buildPartial

public ExtAuthz buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder
clone

public ExtAuthz.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
setField

public ExtAuthz.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
clearField

public ExtAuthz.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
clearOneof

public ExtAuthz.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
setRepeatedField

public ExtAuthz.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
addRepeatedField

public ExtAuthz.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
mergeFrom

public ExtAuthz.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>
mergeFrom

public ExtAuthz.Builder mergeFrom(ExtAuthz other)
isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
mergeFrom

public ExtAuthz.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>

Throws:

IOException
getServicesCase

public ExtAuthz.ServicesCase getServicesCase()

Specified by:

getServicesCase in interface ExtAuthzOrBuilder
clearServices

public ExtAuthz.Builder clearServices()
hasGrpcService

public boolean hasGrpcService()
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
Specified by:

hasGrpcService in interface ExtAuthzOrBuilder

Returns:

Whether the grpcService field is set.
getGrpcService

public GrpcService getGrpcService()
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
Specified by:

getGrpcService in interface ExtAuthzOrBuilder

Returns:

The grpcService.
setGrpcService

public ExtAuthz.Builder setGrpcService(GrpcService value)
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
setGrpcService

public ExtAuthz.Builder setGrpcService(GrpcService.Builder builderForValue)
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
mergeGrpcService

public ExtAuthz.Builder mergeGrpcService(GrpcService value)
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
clearGrpcService

public ExtAuthz.Builder clearGrpcService()
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
getGrpcServiceBuilder

public GrpcService.Builder getGrpcServiceBuilder()
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
getGrpcServiceOrBuilder

public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
```
 gRPC service configuration (default timeout: 200ms).
 
```
.envoy.config.core.v3.GrpcService grpc_service = 1;
Specified by:

getGrpcServiceOrBuilder in interface ExtAuthzOrBuilder
hasHttpService

public boolean hasHttpService()
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
Specified by:

hasHttpService in interface ExtAuthzOrBuilder

Returns:

Whether the httpService field is set.
getHttpService

public HttpService getHttpService()
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
Specified by:

getHttpService in interface ExtAuthzOrBuilder

Returns:

The httpService.
setHttpService

public ExtAuthz.Builder setHttpService(HttpService value)
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
setHttpService

public ExtAuthz.Builder setHttpService(HttpService.Builder builderForValue)
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
mergeHttpService

public ExtAuthz.Builder mergeHttpService(HttpService value)
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
clearHttpService

public ExtAuthz.Builder clearHttpService()
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
getHttpServiceBuilder

public HttpService.Builder getHttpServiceBuilder()
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
getHttpServiceOrBuilder

public HttpServiceOrBuilder getHttpServiceOrBuilder()
```
 HTTP service configuration (default timeout: 200ms).
 
```
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;
Specified by:

getHttpServiceOrBuilder in interface ExtAuthzOrBuilder
getTransportApiVersionValue

public int getTransportApiVersionValue()
```
 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of messages used on the wire.
 
```
.envoy.config.core.v3.ApiVersion transport_api_version = 12 [(.validate.rules) = { ... }
Specified by:

getTransportApiVersionValue in interface ExtAuthzOrBuilder

Returns:

The enum numeric value on the wire for transportApiVersion.
setTransportApiVersionValue

public ExtAuthz.Builder setTransportApiVersionValue(int value)
```
 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of messages used on the wire.
 
```
.envoy.config.core.v3.ApiVersion transport_api_version = 12 [(.validate.rules) = { ... }
Parameters:

value - The enum numeric value on the wire for transportApiVersion to set.

Returns:

This builder for chaining.
getTransportApiVersion

public ApiVersion getTransportApiVersion()
```
 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of messages used on the wire.
 
```
.envoy.config.core.v3.ApiVersion transport_api_version = 12 [(.validate.rules) = { ... }
Specified by:

getTransportApiVersion in interface ExtAuthzOrBuilder

Returns:

The transportApiVersion.
setTransportApiVersion

public ExtAuthz.Builder setTransportApiVersion(ApiVersion value)
```
 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of messages used on the wire.
 
```
.envoy.config.core.v3.ApiVersion transport_api_version = 12 [(.validate.rules) = { ... }
Parameters:

value - The transportApiVersion to set.

Returns:

This builder for chaining.
clearTransportApiVersion

public ExtAuthz.Builder clearTransportApiVersion()
```
 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of messages used on the wire.
 
```
.envoy.config.core.v3.ApiVersion transport_api_version = 12 [(.validate.rules) = { ... }
Returns:

This builder for chaining.

getFailureModeAllow

public boolean getFailureModeAllow()

 Changes the filter's behavior on errors:

 * When set to ``true``, the filter will ``accept`` the client request even if communication with
   the authorization service has failed, or if the authorization service has returned an HTTP 5xx
   error.

 * When set to ``false``, the filter will ``reject`` client requests and return ``Forbidden``
   if communication with the authorization service has failed, or if the authorization service
   has returned an HTTP 5xx error.

 Errors can always be tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.

 Defaults to ``false``.

bool failure_mode_allow = 2;

Specified by:: getFailureModeAllow in interface ExtAuthzOrBuilder
Returns:: The failureModeAllow.

setFailureModeAllow

public ExtAuthz.Builder setFailureModeAllow(boolean value)

 Changes the filter's behavior on errors:

 * When set to ``true``, the filter will ``accept`` the client request even if communication with
   the authorization service has failed, or if the authorization service has returned an HTTP 5xx
   error.

 * When set to ``false``, the filter will ``reject`` client requests and return ``Forbidden``
   if communication with the authorization service has failed, or if the authorization service
   has returned an HTTP 5xx error.

 Errors can always be tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.

 Defaults to ``false``.

bool failure_mode_allow = 2;

Parameters:: value - The failureModeAllow to set.
Returns:: This builder for chaining.

clearFailureModeAllow

public ExtAuthz.Builder clearFailureModeAllow()

 Changes the filter's behavior on errors:

 * When set to ``true``, the filter will ``accept`` the client request even if communication with
   the authorization service has failed, or if the authorization service has returned an HTTP 5xx
   error.

 * When set to ``false``, the filter will ``reject`` client requests and return ``Forbidden``
   if communication with the authorization service has failed, or if the authorization service
   has returned an HTTP 5xx error.

 Errors can always be tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.

 Defaults to ``false``.

bool failure_mode_allow = 2;

Returns:: This builder for chaining.

getFailureModeAllowHeaderAdd

public boolean getFailureModeAllowHeaderAdd()

 When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``,
 ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication
 with the authorization service has failed, or if the authorization service has returned a
 HTTP 5xx error.

bool failure_mode_allow_header_add = 19;

Specified by:: getFailureModeAllowHeaderAdd in interface ExtAuthzOrBuilder
Returns:: The failureModeAllowHeaderAdd.

setFailureModeAllowHeaderAdd

public ExtAuthz.Builder setFailureModeAllowHeaderAdd(boolean value)

 When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``,
 ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication
 with the authorization service has failed, or if the authorization service has returned a
 HTTP 5xx error.

bool failure_mode_allow_header_add = 19;

Parameters:: value - The failureModeAllowHeaderAdd to set.
Returns:: This builder for chaining.

clearFailureModeAllowHeaderAdd

public ExtAuthz.Builder clearFailureModeAllowHeaderAdd()

 When ``failure_mode_allow`` and ``failure_mode_allow_header_add`` are both set to ``true``,
 ``x-envoy-auth-failure-mode-allowed: true`` will be added to request headers if the communication
 with the authorization service has failed, or if the authorization service has returned a
 HTTP 5xx error.

bool failure_mode_allow_header_add = 19;

Returns:: This builder for chaining.

hasWithRequestBody

public boolean hasWithRequestBody()

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

Specified by:: hasWithRequestBody in interface ExtAuthzOrBuilder
Returns:: Whether the withRequestBody field is set.

getWithRequestBody

public BufferSettings getWithRequestBody()

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

Specified by:: getWithRequestBody in interface ExtAuthzOrBuilder
Returns:: The withRequestBody.

setWithRequestBody

public ExtAuthz.Builder setWithRequestBody(BufferSettings value)

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

setWithRequestBody

public ExtAuthz.Builder setWithRequestBody(BufferSettings.Builder builderForValue)

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

mergeWithRequestBody

public ExtAuthz.Builder mergeWithRequestBody(BufferSettings value)

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

clearWithRequestBody

public ExtAuthz.Builder clearWithRequestBody()

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

getWithRequestBodyBuilder

public BufferSettings.Builder getWithRequestBodyBuilder()

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

getWithRequestBodyOrBuilder

public BufferSettingsOrBuilder getWithRequestBodyOrBuilder()

 Enables the filter to buffer the client request body and send it within the authorization request.
 The ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization
 request indicating whether the body data is partial.

.envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;

Specified by:: getWithRequestBodyOrBuilder in interface ExtAuthzOrBuilder

getClearRouteCache

public boolean getClearRouteCache()

 Clears the route cache in order to allow the external authorization service to correctly affect
 routing decisions. The filter clears all cached routes when all of the following holds:

 * This field is set to ``true``.
 * The status returned from the authorization service is an HTTP 200 or gRPC 0.
 * At least one ``authorization response header`` is added to the client request, or is used to
   alter another client request header.

 Defaults to ``false``.

bool clear_route_cache = 6;

Specified by:: getClearRouteCache in interface ExtAuthzOrBuilder
Returns:: The clearRouteCache.

setClearRouteCache

public ExtAuthz.Builder setClearRouteCache(boolean value)

 Clears the route cache in order to allow the external authorization service to correctly affect
 routing decisions. The filter clears all cached routes when all of the following holds:

 * This field is set to ``true``.
 * The status returned from the authorization service is an HTTP 200 or gRPC 0.
 * At least one ``authorization response header`` is added to the client request, or is used to
   alter another client request header.

 Defaults to ``false``.

bool clear_route_cache = 6;

Parameters:: value - The clearRouteCache to set.
Returns:: This builder for chaining.

clearClearRouteCache

public ExtAuthz.Builder clearClearRouteCache()

 Clears the route cache in order to allow the external authorization service to correctly affect
 routing decisions. The filter clears all cached routes when all of the following holds:

 * This field is set to ``true``.
 * The status returned from the authorization service is an HTTP 200 or gRPC 0.
 * At least one ``authorization response header`` is added to the client request, or is used to
   alter another client request header.

 Defaults to ``false``.

bool clear_route_cache = 6;

Returns:: This builder for chaining.

hasStatusOnError

public boolean hasStatusOnError()
```
 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.
 
```
.envoy.type.v3.HttpStatus status_on_error = 7;
Specified by:

hasStatusOnError in interface ExtAuthzOrBuilder

Returns:

Whether the statusOnError field is set.
getStatusOnError

public HttpStatus getStatusOnError()
```
 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.
 
```
.envoy.type.v3.HttpStatus status_on_error = 7;
Specified by:

getStatusOnError in interface ExtAuthzOrBuilder

Returns:

The statusOnError.

setStatusOnError

public ExtAuthz.Builder setStatusOnError(HttpStatus value)

 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.

.envoy.type.v3.HttpStatus status_on_error = 7;

setStatusOnError

public ExtAuthz.Builder setStatusOnError(HttpStatus.Builder builderForValue)

 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.

.envoy.type.v3.HttpStatus status_on_error = 7;

mergeStatusOnError

public ExtAuthz.Builder mergeStatusOnError(HttpStatus value)

 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.

.envoy.type.v3.HttpStatus status_on_error = 7;

clearStatusOnError

public ExtAuthz.Builder clearStatusOnError()

 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.

.envoy.type.v3.HttpStatus status_on_error = 7;

getStatusOnErrorBuilder

public HttpStatus.Builder getStatusOnErrorBuilder()

 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.

.envoy.type.v3.HttpStatus status_on_error = 7;

getStatusOnErrorOrBuilder

public HttpStatusOrBuilder getStatusOnErrorOrBuilder()
```
 Sets the HTTP status that is returned to the client when the authorization server returns an error
 or cannot be reached.

 The default status is ``HTTP 403 Forbidden``.
 
```
.envoy.type.v3.HttpStatus status_on_error = 7;
Specified by:

getStatusOnErrorOrBuilder in interface ExtAuthzOrBuilder

getValidateMutations

public boolean getValidateMutations()

 When set to ``true``, the filter will check the :ref:`ext_authz response
 <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and
 query parameter mutations. If the response is invalid, the filter will send a local reply
 to the downstream request with status ``HTTP 500 Internal Server Error``.

 .. note::
   Both ``headers_to_remove`` and ``query_parameters_to_remove`` are validated, but invalid elements in
   those fields should not affect any headers and thus will not cause the filter to send a local reply.

 When set to ``false``, any invalid mutations will be visible to the rest of Envoy and may cause
 unexpected behavior.

 If you are using ext_authz with an untrusted ext_authz server, you should set this to ``true``.

 Defaults to ``false``.

bool validate_mutations = 24;

Specified by:: getValidateMutations in interface ExtAuthzOrBuilder
Returns:: The validateMutations.

setValidateMutations

public ExtAuthz.Builder setValidateMutations(boolean value)

 When set to ``true``, the filter will check the :ref:`ext_authz response
 <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and
 query parameter mutations. If the response is invalid, the filter will send a local reply
 to the downstream request with status ``HTTP 500 Internal Server Error``.

 .. note::
   Both ``headers_to_remove`` and ``query_parameters_to_remove`` are validated, but invalid elements in
   those fields should not affect any headers and thus will not cause the filter to send a local reply.

 When set to ``false``, any invalid mutations will be visible to the rest of Envoy and may cause
 unexpected behavior.

 If you are using ext_authz with an untrusted ext_authz server, you should set this to ``true``.

 Defaults to ``false``.

bool validate_mutations = 24;

Parameters:: value - The validateMutations to set.
Returns:: This builder for chaining.

clearValidateMutations

public ExtAuthz.Builder clearValidateMutations()

 When set to ``true``, the filter will check the :ref:`ext_authz response
 <envoy_v3_api_msg_service.auth.v3.CheckResponse>` for invalid header and
 query parameter mutations. If the response is invalid, the filter will send a local reply
 to the downstream request with status ``HTTP 500 Internal Server Error``.

 .. note::
   Both ``headers_to_remove`` and ``query_parameters_to_remove`` are validated, but invalid elements in
   those fields should not affect any headers and thus will not cause the filter to send a local reply.

 When set to ``false``, any invalid mutations will be visible to the rest of Envoy and may cause
 unexpected behavior.

 If you are using ext_authz with an untrusted ext_authz server, you should set this to ``true``.

 Defaults to ``false``.

bool validate_mutations = 24;

Returns:: This builder for chaining.

getMetadataContextNamespacesList

public com.google.protobuf.ProtocolStringList getMetadataContextNamespacesList()

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Specified by:: getMetadataContextNamespacesList in interface ExtAuthzOrBuilder
Returns:: A list containing the metadataContextNamespaces.

getMetadataContextNamespacesCount

public int getMetadataContextNamespacesCount()

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Specified by:: getMetadataContextNamespacesCount in interface ExtAuthzOrBuilder
Returns:: The count of metadataContextNamespaces.

getMetadataContextNamespaces

public String getMetadataContextNamespaces(int index)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Specified by:: getMetadataContextNamespaces in interface ExtAuthzOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The metadataContextNamespaces at the given index.

getMetadataContextNamespacesBytes

public com.google.protobuf.ByteString getMetadataContextNamespacesBytes(int index)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Specified by:: getMetadataContextNamespacesBytes in interface ExtAuthzOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the metadataContextNamespaces at the given index.

setMetadataContextNamespaces

public ExtAuthz.Builder setMetadataContextNamespaces(int index, String value)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Parameters:: index - The index to set the value at.; value - The metadataContextNamespaces to set.
Returns:: This builder for chaining.

addMetadataContextNamespaces

public ExtAuthz.Builder addMetadataContextNamespaces(String value)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Parameters:: value - The metadataContextNamespaces to add.
Returns:: This builder for chaining.

addAllMetadataContextNamespaces

public ExtAuthz.Builder addAllMetadataContextNamespaces(Iterable<String> values)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Parameters:: values - The metadataContextNamespaces to add.
Returns:: This builder for chaining.

clearMetadataContextNamespaces

public ExtAuthz.Builder clearMetadataContextNamespaces()

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Returns:: This builder for chaining.

addMetadataContextNamespacesBytes

public ExtAuthz.Builder addMetadataContextNamespacesBytes(com.google.protobuf.ByteString value)

 Specifies a list of metadata namespaces whose values, if present, will be passed to the
 ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
 is passed as an opaque ``protobuf::Struct``.

 .. note::
   This field applies exclusively to the gRPC ext_authz service and has no effect on the HTTP service.

 For example, if the ``jwt_authn`` filter is used and :ref:`payload_in_metadata
 <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
 then the following will pass the jwt payload to the authorization server.

 .. code-block:: yaml

    metadata_context_namespaces:
    - envoy.filters.http.jwt_authn

repeated string metadata_context_namespaces = 8;

Parameters:: value - The bytes of the metadataContextNamespaces to add.
Returns:: This builder for chaining.