Class ExtAuthz.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
io.envoyproxy.envoy.config.filter.http.ext_authz.v2.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: 12]Protobuf type
envoy.config.filter.http.ext_authz.v2.ExtAuthz-
Method Summary
Modifier and TypeMethodDescriptionSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.addMetadataContextNamespacesBytes(com.google.protobuf.ByteString value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()Clears route cache in order to allow the external authorization service to correctly affect routing decisions.Specifies whether to deny the requests, when the filter is disabled.Changes filter's behaviour on errors: 1.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) Specifies if the filter is enabled.gRPC service configuration (default timeout: 200ms).HTTP service configuration (default timeout: 200ms).Specifies if the peer certificate is sent to the external service.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.Deprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated.Enables filter to buffer the client request body and send it within the authorization request.clone()booleanClears route cache in order to allow the external authorization service to correctly affect routing decisions.Specifies whether to deny the requests, when the filter is disabled.Specifies whether to deny the requests, when the filter is disabled.Specifies whether to deny the requests, when the filter is disabled.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorbooleanChanges filter's behaviour on errors: 1.Specifies if the filter is enabled.Specifies if the filter is enabled.Specifies if the filter is enabled.gRPC service configuration (default timeout: 200ms).gRPC service configuration (default timeout: 200ms).gRPC service configuration (default timeout: 200ms).HTTP service configuration (default timeout: 200ms).HTTP service configuration (default timeout: 200ms).HTTP service configuration (default timeout: 200ms).booleanSpecifies if the peer certificate is sent to the external service.getMetadataContextNamespaces(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.com.google.protobuf.ByteStringgetMetadataContextNamespacesBytes(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.intSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.com.google.protobuf.ProtocolStringListSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.booleanDeprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated.Enables filter to buffer the client request body and send it within the authorization request.Enables filter to buffer the client request body and send it within the authorization request.Enables filter to buffer the client request body and send it within the authorization request.booleanSpecifies whether to deny the requests, when the filter is disabled.booleanSpecifies if the filter is enabled.booleangRPC service configuration (default timeout: 200ms).booleanHTTP service configuration (default timeout: 200ms).booleanSets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.booleanEnables filter to buffer the client request body and send it within the authorization request.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanSpecifies whether to deny the requests, when the filter is disabled.Specifies if the filter is enabled.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeGrpcService(GrpcService value) gRPC service configuration (default timeout: 200ms).mergeHttpService(HttpService value) HTTP service configuration (default timeout: 200ms).mergeStatusOnError(HttpStatus value) Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.final ExtAuthz.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Enables filter to buffer the client request body and send it within the authorization request.setClearRouteCache(boolean value) Clears route cache in order to allow the external authorization service to correctly affect routing decisions.Specifies whether to deny the requests, when the filter is disabled.setDenyAtDisable(RuntimeFeatureFlag.Builder builderForValue) Specifies whether to deny the requests, when the filter is disabled.setFailureModeAllow(boolean value) Changes filter's behaviour on errors: 1.Specifies if the filter is enabled.setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue) Specifies if the filter is enabled.setGrpcService(GrpcService value) gRPC service configuration (default timeout: 200ms).setGrpcService(GrpcService.Builder builderForValue) gRPC service configuration (default timeout: 200ms).setHttpService(HttpService value) HTTP service configuration (default timeout: 200ms).setHttpService(HttpService.Builder builderForValue) HTTP service configuration (default timeout: 200ms).setIncludePeerCertificate(boolean value) Specifies if the peer certificate is sent to the external service.setMetadataContextNamespaces(int index, String value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setStatusOnError(HttpStatus value) Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.setStatusOnError(HttpStatus.Builder builderForValue) Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.final ExtAuthz.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setUseAlpha(boolean value) Deprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated.setWithRequestBody(BufferSettings value) Enables filter to buffer the client request body and send it within the authorization request.setWithRequestBody(BufferSettings.Builder builderForValue) Enables 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, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods 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:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
setField
public ExtAuthz.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
setRepeatedField
public ExtAuthz.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
addRepeatedField
public ExtAuthz.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>- Throws:
IOException
-
getServicesCase
- Specified by:
getServicesCasein interfaceExtAuthzOrBuilder
-
clearServices
-
hasGrpcService
public boolean hasGrpcService()gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1;- Specified by:
hasGrpcServicein interfaceExtAuthzOrBuilder- Returns:
- Whether the grpcService field is set.
-
getGrpcService
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1;- Specified by:
getGrpcServicein interfaceExtAuthzOrBuilder- Returns:
- The grpcService.
-
setGrpcService
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1; -
setGrpcService
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1; -
mergeGrpcService
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1; -
clearGrpcService
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1; -
getGrpcServiceBuilder
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1; -
getGrpcServiceOrBuilder
gRPC service configuration (default timeout: 200ms).
.envoy.api.v2.core.GrpcService grpc_service = 1;- Specified by:
getGrpcServiceOrBuilderin interfaceExtAuthzOrBuilder
-
hasHttpService
public boolean hasHttpService()HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3;- Specified by:
hasHttpServicein interfaceExtAuthzOrBuilder- Returns:
- Whether the httpService field is set.
-
getHttpService
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3;- Specified by:
getHttpServicein interfaceExtAuthzOrBuilder- Returns:
- The httpService.
-
setHttpService
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3; -
setHttpService
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3; -
mergeHttpService
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3; -
clearHttpService
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3; -
getHttpServiceBuilder
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3; -
getHttpServiceOrBuilder
HTTP service configuration (default timeout: 200ms).
.envoy.config.filter.http.ext_authz.v2.HttpService http_service = 3;- Specified by:
getHttpServiceOrBuilderin interfaceExtAuthzOrBuilder
-
getFailureModeAllow
public boolean getFailureModeAllow()Changes filter's behaviour on errors: 1. When set to true, the filter will *accept* client request even if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. 2. When set to false, ext-authz will *reject* client requests and return a *Forbidden* response if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. Note that errors can be *always* tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.
bool failure_mode_allow = 2;- Specified by:
getFailureModeAllowin interfaceExtAuthzOrBuilder- Returns:
- The failureModeAllow.
-
setFailureModeAllow
Changes filter's behaviour on errors: 1. When set to true, the filter will *accept* client request even if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. 2. When set to false, ext-authz will *reject* client requests and return a *Forbidden* response if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. Note that errors can be *always* tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.
bool failure_mode_allow = 2;- Parameters:
value- The failureModeAllow to set.- Returns:
- This builder for chaining.
-
clearFailureModeAllow
Changes filter's behaviour on errors: 1. When set to true, the filter will *accept* client request even if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. 2. When set to false, ext-authz will *reject* client requests and return a *Forbidden* response if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. Note that errors can be *always* tracked in the :ref:`stats <config_http_filters_ext_authz_stats>`.
bool failure_mode_allow = 2;- Returns:
- This builder for chaining.
-
getUseAlpha
Deprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated. See envoy/config/filter/http/ext_authz/v2/ext_authz.proto;l=53[#not-implemented-hide: Support for this field has been removed.]
bool use_alpha = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];- Specified by:
getUseAlphain interfaceExtAuthzOrBuilder- Returns:
- The useAlpha.
-
setUseAlpha
Deprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated. See envoy/config/filter/http/ext_authz/v2/ext_authz.proto;l=53[#not-implemented-hide: Support for this field has been removed.]
bool use_alpha = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];- Parameters:
value- The useAlpha to set.- Returns:
- This builder for chaining.
-
clearUseAlpha
Deprecated.envoy.config.filter.http.ext_authz.v2.ExtAuthz.use_alpha is deprecated. See envoy/config/filter/http/ext_authz/v2/ext_authz.proto;l=53[#not-implemented-hide: Support for this field has been removed.]
bool use_alpha = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];- Returns:
- This builder for chaining.
-
hasWithRequestBody
public boolean hasWithRequestBody()Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5;- Specified by:
hasWithRequestBodyin interfaceExtAuthzOrBuilder- Returns:
- Whether the withRequestBody field is set.
-
getWithRequestBody
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5;- Specified by:
getWithRequestBodyin interfaceExtAuthzOrBuilder- Returns:
- The withRequestBody.
-
setWithRequestBody
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5; -
setWithRequestBody
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5; -
mergeWithRequestBody
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5; -
clearWithRequestBody
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5; -
getWithRequestBodyBuilder
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5; -
getWithRequestBodyOrBuilder
Enables filter to buffer the client request body and send it within the authorization request. A ``x-envoy-auth-partial-body: false|true`` metadata header will be added to the authorization request message indicating if the body data is partial.
.envoy.config.filter.http.ext_authz.v2.BufferSettings with_request_body = 5;- Specified by:
getWithRequestBodyOrBuilderin interfaceExtAuthzOrBuilder
-
getClearRouteCache
public boolean getClearRouteCache()Clears route cache in order to allow the external authorization service to correctly affect routing decisions. Filter clears all cached routes when: 1. The field is set to *true*. 2. The status returned from the authorization service is a HTTP 200 or gRPC 0. 3. At least one *authorization response header* is added to the client request, or is used for altering another client request header.
bool clear_route_cache = 6;- Specified by:
getClearRouteCachein interfaceExtAuthzOrBuilder- Returns:
- The clearRouteCache.
-
setClearRouteCache
Clears route cache in order to allow the external authorization service to correctly affect routing decisions. Filter clears all cached routes when: 1. The field is set to *true*. 2. The status returned from the authorization service is a HTTP 200 or gRPC 0. 3. At least one *authorization response header* is added to the client request, or is used for altering another client request header.
bool clear_route_cache = 6;- Parameters:
value- The clearRouteCache to set.- Returns:
- This builder for chaining.
-
clearClearRouteCache
Clears route cache in order to allow the external authorization service to correctly affect routing decisions. Filter clears all cached routes when: 1. The field is set to *true*. 2. The status returned from the authorization service is a HTTP 200 or gRPC 0. 3. At least one *authorization response header* is added to the client request, or is used for altering another client request header.
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 there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7;- Specified by:
hasStatusOnErrorin interfaceExtAuthzOrBuilder- Returns:
- Whether the statusOnError field is set.
-
getStatusOnError
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7;- Specified by:
getStatusOnErrorin interfaceExtAuthzOrBuilder- Returns:
- The statusOnError.
-
setStatusOnError
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7; -
setStatusOnError
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7; -
mergeStatusOnError
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7; -
clearStatusOnError
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7; -
getStatusOnErrorBuilder
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7; -
getStatusOnErrorOrBuilder
Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server. The default status is HTTP 403 Forbidden.
.envoy.type.HttpStatus status_on_error = 7;- Specified by:
getStatusOnErrorOrBuilderin interfaceExtAuthzOrBuilder
-
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 as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Specified by:
getMetadataContextNamespacesListin interfaceExtAuthzOrBuilder- 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 as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Specified by:
getMetadataContextNamespacesCountin interfaceExtAuthzOrBuilder- Returns:
- The count of metadataContextNamespaces.
-
getMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Specified by:
getMetadataContextNamespacesin interfaceExtAuthzOrBuilder- 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 as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Specified by:
getMetadataContextNamespacesBytesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the metadataContextNamespaces at the given index.
-
setMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated 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
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Parameters:
value- The metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
addAllMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Parameters:
values- The metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
clearMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Returns:
- This builder for chaining.
-
addMetadataContextNamespacesBytes
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service as an opaque *protobuf::Struct*. For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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_authnrepeated string metadata_context_namespaces = 8;- Parameters:
value- The bytes of the metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
hasFilterEnabled
public boolean hasFilterEnabled()Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
hasFilterEnabledin interfaceExtAuthzOrBuilder- Returns:
- Whether the filterEnabled field is set.
-
getFilterEnabled
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
getFilterEnabledin interfaceExtAuthzOrBuilder- Returns:
- The filterEnabled.
-
setFilterEnabled
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9; -
setFilterEnabled
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9; -
mergeFilterEnabled
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9; -
clearFilterEnabled
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9; -
getFilterEnabledBuilder
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9; -
getFilterEnabledOrBuilder
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter. If this field is not specified, the filter will be enabled for all requests.
.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
getFilterEnabledOrBuilderin interfaceExtAuthzOrBuilder
-
hasDenyAtDisable
public boolean hasDenyAtDisable()Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11;- Specified by:
hasDenyAtDisablein interfaceExtAuthzOrBuilder- Returns:
- Whether the denyAtDisable field is set.
-
getDenyAtDisable
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11;- Specified by:
getDenyAtDisablein interfaceExtAuthzOrBuilder- Returns:
- The denyAtDisable.
-
setDenyAtDisable
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11; -
setDenyAtDisable
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11; -
mergeDenyAtDisable
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11; -
clearDenyAtDisable
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11; -
getDenyAtDisableBuilder
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11; -
getDenyAtDisableOrBuilder
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_api_field_core.RuntimeFeatureFlag.runtime_key>` is specified, Envoy will lookup the runtime key to determine whether to deny request for filter protected path at filter disabling. If filter is disabled in typed_per_filter_config for the path, requests will not be denied. If this field is not specified, all requests will be allowed when disabled.
.envoy.api.v2.core.RuntimeFeatureFlag deny_at_disable = 11;- Specified by:
getDenyAtDisableOrBuilderin interfaceExtAuthzOrBuilder
-
getIncludePeerCertificate
public boolean getIncludePeerCertificate()Specifies if the peer certificate is sent to the external service. When this field is true, Envoy will include the peer X.509 certificate, if available, in the :ref:`certificate<envoy_api_field_service.auth.v2.AttributeContext.Peer.certificate>`.
bool include_peer_certificate = 10;- Specified by:
getIncludePeerCertificatein interfaceExtAuthzOrBuilder- Returns:
- The includePeerCertificate.
-
setIncludePeerCertificate
Specifies if the peer certificate is sent to the external service. When this field is true, Envoy will include the peer X.509 certificate, if available, in the :ref:`certificate<envoy_api_field_service.auth.v2.AttributeContext.Peer.certificate>`.
bool include_peer_certificate = 10;- Parameters:
value- The includePeerCertificate to set.- Returns:
- This builder for chaining.
-
clearIncludePeerCertificate
Specifies if the peer certificate is sent to the external service. When this field is true, Envoy will include the peer X.509 certificate, if available, in the :ref:`certificate<envoy_api_field_service.auth.v2.AttributeContext.Peer.certificate>`.
bool include_peer_certificate = 10;- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-