Class ExtAuthz
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3.ExtAuthz
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ExtAuthzOrBuilder,Serializable
public final class ExtAuthz extends com.google.protobuf.GeneratedMessageV3 implements ExtAuthzOrBuilder
[#next-free-field: 17]
Protobuf typeenvoy.extensions.filters.http.ext_authz.v3.ExtAuthz- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classExtAuthz.Builder[#next-free-field: 17]static classExtAuthz.ServicesCase-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intBOOTSTRAP_METADATA_LABELS_KEY_FIELD_NUMBERstatic intCLEAR_ROUTE_CACHE_FIELD_NUMBERstatic intDENY_AT_DISABLE_FIELD_NUMBERstatic intFAILURE_MODE_ALLOW_FIELD_NUMBERstatic intFILTER_ENABLED_FIELD_NUMBERstatic intFILTER_ENABLED_METADATA_FIELD_NUMBERstatic intGRPC_SERVICE_FIELD_NUMBERstatic intHTTP_SERVICE_FIELD_NUMBERstatic intINCLUDE_PEER_CERTIFICATE_FIELD_NUMBERstatic intMETADATA_CONTEXT_NAMESPACES_FIELD_NUMBERstatic intSTAT_PREFIX_FIELD_NUMBERstatic intSTATUS_ON_ERROR_FIELD_NUMBERstatic intTRANSPORT_API_VERSION_FIELD_NUMBERstatic intTYPED_METADATA_CONTEXT_NAMESPACES_FIELD_NUMBERstatic intWITH_REQUEST_BODY_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)StringgetBootstrapMetadataLabelsKey()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.ByteStringgetBootstrapMetadataLabelsKeyBytes()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>`.booleangetClearRouteCache()Clears route cache in order to allow the external authorization service to correctly affect routing decisions.static ExtAuthzgetDefaultInstance()ExtAuthzgetDefaultInstanceForType()RuntimeFeatureFlaggetDenyAtDisable()Specifies whether to deny the requests, when the filter is disabled.RuntimeFeatureFlagOrBuildergetDenyAtDisableOrBuilder()Specifies whether to deny the requests, when the filter is disabled.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()booleangetFailureModeAllow()Changes filter's behaviour on errors: 1.RuntimeFractionalPercentgetFilterEnabled()Specifies if the filter is enabled.MetadataMatchergetFilterEnabledMetadata()Specifies if the filter is enabled with metadata matcher.MetadataMatcherOrBuildergetFilterEnabledMetadataOrBuilder()Specifies if the filter is enabled with metadata matcher.RuntimeFractionalPercentOrBuildergetFilterEnabledOrBuilder()Specifies if the filter is enabled.GrpcServicegetGrpcService()gRPC service configuration (default timeout: 200ms).GrpcServiceOrBuildergetGrpcServiceOrBuilder()gRPC service configuration (default timeout: 200ms).HttpServicegetHttpService()HTTP service configuration (default timeout: 200ms).HttpServiceOrBuildergetHttpServiceOrBuilder()HTTP service configuration (default timeout: 200ms).booleangetIncludePeerCertificate()Specifies if the peer certificate is sent to the external service.StringgetMetadataContextNamespaces(int index)Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ByteStringgetMetadataContextNamespacesBytes(int index)Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.intgetMetadataContextNamespacesCount()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ProtocolStringListgetMetadataContextNamespacesList()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.Parser<ExtAuthz>getParserForType()intgetSerializedSize()ExtAuthz.ServicesCasegetServicesCase()StringgetStatPrefix()Optional additional prefix to use when emitting statistics.com.google.protobuf.ByteStringgetStatPrefixBytes()Optional additional prefix to use when emitting statistics.HttpStatusgetStatusOnError()Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.HttpStatusOrBuildergetStatusOnErrorOrBuilder()Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.ApiVersiongetTransportApiVersion()API version for ext_authz transport protocol.intgetTransportApiVersionValue()API version for ext_authz transport protocol.StringgetTypedMetadataContextNamespaces(int index)Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ByteStringgetTypedMetadataContextNamespacesBytes(int index)Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.intgetTypedMetadataContextNamespacesCount()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ProtocolStringListgetTypedMetadataContextNamespacesList()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.UnknownFieldSetgetUnknownFields()BufferSettingsgetWithRequestBody()Enables filter to buffer the client request body and send it within the authorization request.BufferSettingsOrBuildergetWithRequestBodyOrBuilder()Enables filter to buffer the client request body and send it within the authorization request.booleanhasDenyAtDisable()Specifies whether to deny the requests, when the filter is disabled.booleanhasFilterEnabled()Specifies if the filter is enabled.booleanhasFilterEnabledMetadata()Specifies if the filter is enabled with metadata matcher.booleanhasGrpcService()gRPC service configuration (default timeout: 200ms).inthashCode()booleanhasHttpService()HTTP service configuration (default timeout: 200ms).booleanhasStatusOnError()Sets the HTTP status that is returned to the client when there is a network error between the filter and the authorization server.booleanhasWithRequestBody()Enables filter to buffer the client request body and send it within the authorization request.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static ExtAuthz.BuildernewBuilder()static ExtAuthz.BuildernewBuilder(ExtAuthz prototype)ExtAuthz.BuildernewBuilderForType()protected ExtAuthz.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static ExtAuthzparseDelimitedFrom(InputStream input)static ExtAuthzparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ExtAuthzparseFrom(byte[] data)static ExtAuthzparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ExtAuthzparseFrom(com.google.protobuf.ByteString data)static ExtAuthzparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ExtAuthzparseFrom(com.google.protobuf.CodedInputStream input)static ExtAuthzparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ExtAuthzparseFrom(InputStream input)static ExtAuthzparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ExtAuthzparseFrom(ByteBuffer data)static ExtAuthzparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<ExtAuthz>parser()ExtAuthz.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
GRPC_SERVICE_FIELD_NUMBER
public static final int GRPC_SERVICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
HTTP_SERVICE_FIELD_NUMBER
public static final int HTTP_SERVICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRANSPORT_API_VERSION_FIELD_NUMBER
public static final int TRANSPORT_API_VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FAILURE_MODE_ALLOW_FIELD_NUMBER
public static final int FAILURE_MODE_ALLOW_FIELD_NUMBER
- See Also:
- Constant Field Values
-
WITH_REQUEST_BODY_FIELD_NUMBER
public static final int WITH_REQUEST_BODY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLEAR_ROUTE_CACHE_FIELD_NUMBER
public static final int CLEAR_ROUTE_CACHE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATUS_ON_ERROR_FIELD_NUMBER
public static final int STATUS_ON_ERROR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METADATA_CONTEXT_NAMESPACES_FIELD_NUMBER
public static final int METADATA_CONTEXT_NAMESPACES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPED_METADATA_CONTEXT_NAMESPACES_FIELD_NUMBER
public static final int TYPED_METADATA_CONTEXT_NAMESPACES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_ENABLED_FIELD_NUMBER
public static final int FILTER_ENABLED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_ENABLED_METADATA_FIELD_NUMBER
public static final int FILTER_ENABLED_METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DENY_AT_DISABLE_FIELD_NUMBER
public static final int DENY_AT_DISABLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INCLUDE_PEER_CERTIFICATE_FIELD_NUMBER
public static final int INCLUDE_PEER_CERTIFICATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STAT_PREFIX_FIELD_NUMBER
public static final int STAT_PREFIX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BOOTSTRAP_METADATA_LABELS_KEY_FIELD_NUMBER
public static final int BOOTSTRAP_METADATA_LABELS_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
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
-
getServicesCase
public ExtAuthz.ServicesCase getServicesCase()
- Specified by:
getServicesCasein interfaceExtAuthzOrBuilder
-
hasGrpcService
public boolean hasGrpcService()
gRPC service configuration (default timeout: 200ms).
.envoy.config.core.v3.GrpcService grpc_service = 1;- Specified by:
hasGrpcServicein interfaceExtAuthzOrBuilder- 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:
getGrpcServicein interfaceExtAuthzOrBuilder- Returns:
- The grpcService.
-
getGrpcServiceOrBuilder
public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
gRPC service configuration (default timeout: 200ms).
.envoy.config.core.v3.GrpcService grpc_service = 1;- Specified by:
getGrpcServiceOrBuilderin interfaceExtAuthzOrBuilder
-
hasHttpService
public boolean hasHttpService()
HTTP service configuration (default timeout: 200ms).
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;- Specified by:
hasHttpServicein interfaceExtAuthzOrBuilder- 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:
getHttpServicein interfaceExtAuthzOrBuilder- Returns:
- The httpService.
-
getHttpServiceOrBuilder
public HttpServiceOrBuilder getHttpServiceOrBuilder()
HTTP service configuration (default timeout: 200ms).
.envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 3;- Specified by:
getHttpServiceOrBuilderin interfaceExtAuthzOrBuilder
-
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:
getTransportApiVersionValuein interfaceExtAuthzOrBuilder- Returns:
- The enum numeric value on the wire for transportApiVersion.
-
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:
getTransportApiVersionin interfaceExtAuthzOrBuilder- Returns:
- The transportApiVersion.
-
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.
-
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.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;- Specified by:
hasWithRequestBodyin interfaceExtAuthzOrBuilder- Returns:
- Whether the withRequestBody field is set.
-
getWithRequestBody
public BufferSettings 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.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 5;- Specified by:
getWithRequestBodyin interfaceExtAuthzOrBuilder- Returns:
- The withRequestBody.
-
getWithRequestBodyOrBuilder
public BufferSettingsOrBuilder 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.extensions.filters.http.ext_authz.v3.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.
-
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.v3.HttpStatus status_on_error = 7;- Specified by:
hasStatusOnErrorin interfaceExtAuthzOrBuilder- Returns:
- Whether the statusOnError field is set.
-
getStatusOnError
public HttpStatus 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.v3.HttpStatus status_on_error = 7;- Specified by:
getStatusOnErrorin interfaceExtAuthzOrBuilder- Returns:
- The statusOnError.
-
getStatusOnErrorOrBuilder
public HttpStatusOrBuilder 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.v3.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. :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. 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_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. :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. 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_authnrepeated string metadata_context_namespaces = 8;- Specified by:
getMetadataContextNamespacesCountin interfaceExtAuthzOrBuilder- 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. :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. 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_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. :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. 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_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.
-
getTypedMetadataContextNamespacesList
public com.google.protobuf.ProtocolStringList getTypedMetadataContextNamespacesList()
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as an ``protobuf::Any``. It works in a way similar to ``metadata_context_namespaces`` but allows envoy and external authz server to share the protobuf message definition in order to do a safe parsing.
repeated string typed_metadata_context_namespaces = 16;- Specified by:
getTypedMetadataContextNamespacesListin interfaceExtAuthzOrBuilder- Returns:
- A list containing the typedMetadataContextNamespaces.
-
getTypedMetadataContextNamespacesCount
public int getTypedMetadataContextNamespacesCount()
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as an ``protobuf::Any``. It works in a way similar to ``metadata_context_namespaces`` but allows envoy and external authz server to share the protobuf message definition in order to do a safe parsing.
repeated string typed_metadata_context_namespaces = 16;- Specified by:
getTypedMetadataContextNamespacesCountin interfaceExtAuthzOrBuilder- Returns:
- The count of typedMetadataContextNamespaces.
-
getTypedMetadataContextNamespaces
public String getTypedMetadataContextNamespaces(int index)
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as an ``protobuf::Any``. It works in a way similar to ``metadata_context_namespaces`` but allows envoy and external authz server to share the protobuf message definition in order to do a safe parsing.
repeated string typed_metadata_context_namespaces = 16;- Specified by:
getTypedMetadataContextNamespacesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The typedMetadataContextNamespaces at the given index.
-
getTypedMetadataContextNamespacesBytes
public 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. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as an ``protobuf::Any``. It works in a way similar to ``metadata_context_namespaces`` but allows envoy and external authz server to share the protobuf message definition in order to do a safe parsing.
repeated string typed_metadata_context_namespaces = 16;- Specified by:
getTypedMetadataContextNamespacesBytesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the typedMetadataContextNamespaces at the given index.
-
hasFilterEnabled
public boolean hasFilterEnabled()
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
hasFilterEnabledin interfaceExtAuthzOrBuilder- Returns:
- Whether the filterEnabled field is set.
-
getFilterEnabled
public RuntimeFractionalPercent getFilterEnabled()
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
getFilterEnabledin interfaceExtAuthzOrBuilder- Returns:
- The filterEnabled.
-
getFilterEnabledOrBuilder
public RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()
Specifies if the filter is enabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;- Specified by:
getFilterEnabledOrBuilderin interfaceExtAuthzOrBuilder
-
hasFilterEnabledMetadata
public boolean hasFilterEnabledMetadata()
Specifies if the filter is enabled with metadata matcher. If this field is not specified, the filter will be enabled for all requests.
.envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 14;- Specified by:
hasFilterEnabledMetadatain interfaceExtAuthzOrBuilder- Returns:
- Whether the filterEnabledMetadata field is set.
-
getFilterEnabledMetadata
public MetadataMatcher getFilterEnabledMetadata()
Specifies if the filter is enabled with metadata matcher. If this field is not specified, the filter will be enabled for all requests.
.envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 14;- Specified by:
getFilterEnabledMetadatain interfaceExtAuthzOrBuilder- Returns:
- The filterEnabledMetadata.
-
getFilterEnabledMetadataOrBuilder
public MetadataMatcherOrBuilder getFilterEnabledMetadataOrBuilder()
Specifies if the filter is enabled with metadata matcher. If this field is not specified, the filter will be enabled for all requests.
.envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 14;- Specified by:
getFilterEnabledMetadataOrBuilderin interfaceExtAuthzOrBuilder
-
hasDenyAtDisable
public boolean hasDenyAtDisable()
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.RuntimeFeatureFlag deny_at_disable = 11;- Specified by:
hasDenyAtDisablein interfaceExtAuthzOrBuilder- Returns:
- Whether the denyAtDisable field is set.
-
getDenyAtDisable
public RuntimeFeatureFlag getDenyAtDisable()
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.RuntimeFeatureFlag deny_at_disable = 11;- Specified by:
getDenyAtDisablein interfaceExtAuthzOrBuilder- Returns:
- The denyAtDisable.
-
getDenyAtDisableOrBuilder
public RuntimeFeatureFlagOrBuilder getDenyAtDisableOrBuilder()
Specifies whether to deny the requests, when the filter is disabled. If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.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.config.core.v3.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_v3_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
bool include_peer_certificate = 10;- Specified by:
getIncludePeerCertificatein interfaceExtAuthzOrBuilder- Returns:
- The includePeerCertificate.
-
getStatPrefix
public String getStatPrefix()
Optional additional prefix to use when emitting statistics. This allows to distinguish emitted statistics between configured ``ext_authz`` filters in an HTTP filter chain. For example: .. code-block:: yaml http_filters: - name: envoy.filters.http.ext_authz typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz stat_prefix: waf # This emits ext_authz.waf.ok, ext_authz.waf.denied, etc. - name: envoy.filters.http.ext_authz typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz stat_prefix: blocker # This emits ext_authz.blocker.ok, ext_authz.blocker.denied, etc.string stat_prefix = 13;- Specified by:
getStatPrefixin interfaceExtAuthzOrBuilder- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()
Optional additional prefix to use when emitting statistics. This allows to distinguish emitted statistics between configured ``ext_authz`` filters in an HTTP filter chain. For example: .. code-block:: yaml http_filters: - name: envoy.filters.http.ext_authz typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz stat_prefix: waf # This emits ext_authz.waf.ok, ext_authz.waf.denied, etc. - name: envoy.filters.http.ext_authz typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz stat_prefix: blocker # This emits ext_authz.blocker.ok, ext_authz.blocker.denied, etc.string stat_prefix = 13;- Specified by:
getStatPrefixBytesin interfaceExtAuthzOrBuilder- Returns:
- The bytes for statPrefix.
-
getBootstrapMetadataLabelsKey
public 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>`. The labels will be read from :ref:`metadata<envoy_v3_api_msg_config.core.v3.Node>` with the specified key.
string bootstrap_metadata_labels_key = 15;- Specified by:
getBootstrapMetadataLabelsKeyin interfaceExtAuthzOrBuilder- Returns:
- The bootstrapMetadataLabelsKey.
-
getBootstrapMetadataLabelsKeyBytes
public 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>`. The labels will be read from :ref:`metadata<envoy_v3_api_msg_config.core.v3.Node>` with the specified key.
string bootstrap_metadata_labels_key = 15;- Specified by:
getBootstrapMetadataLabelsKeyBytesin interfaceExtAuthzOrBuilder- Returns:
- The bytes for bootstrapMetadataLabelsKey.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ExtAuthz parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExtAuthz parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExtAuthz parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExtAuthz parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExtAuthz parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static ExtAuthz parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExtAuthz parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public ExtAuthz.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ExtAuthz.Builder newBuilder()
-
newBuilder
public static ExtAuthz.Builder newBuilder(ExtAuthz prototype)
-
toBuilder
public ExtAuthz.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ExtAuthz.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static ExtAuthz getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ExtAuthz> parser()
-
getParserForType
public com.google.protobuf.Parser<ExtAuthz> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public ExtAuthz getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-