Package io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3

Class AuthorizationResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AuthorizationResponseOrBuilder, Serializable
    public final class AuthorizationResponse
extends com.google.protobuf.GeneratedMessageV3
implements AuthorizationResponseOrBuilder
     [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.http.ext_authz.v3.AuthorizationResponse
    See Also:
    Serialized Form

    • Field Detail

      • ALLOWED_UPSTREAM_HEADERS_FIELD_NUMBER

        public static final int ALLOWED_UPSTREAM_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_UPSTREAM_HEADERS_TO_APPEND_FIELD_NUMBER

        public static final int ALLOWED_UPSTREAM_HEADERS_TO_APPEND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_CLIENT_HEADERS_FIELD_NUMBER

        public static final int ALLOWED_CLIENT_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_CLIENT_HEADERS_ON_SUCCESS_FIELD_NUMBER

        public static final int ALLOWED_CLIENT_HEADERS_ON_SUCCESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DYNAMIC_METADATA_FROM_HEADERS_FIELD_NUMBER

        public static final int DYNAMIC_METADATA_FROM_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasAllowedUpstreamHeaders

        public boolean hasAllowedUpstreamHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the original client request.
 Note that coexistent headers will be overridden.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;
        Specified by:
        hasAllowedUpstreamHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        Whether the allowedUpstreamHeaders field is set.

      • getAllowedUpstreamHeaders

        public ListStringMatcher getAllowedUpstreamHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the original client request.
 Note that coexistent headers will be overridden.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;
        Specified by:
        getAllowedUpstreamHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        The allowedUpstreamHeaders.

      • getAllowedUpstreamHeadersOrBuilder

        public ListStringMatcherOrBuilder getAllowedUpstreamHeadersOrBuilder()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the original client request.
 Note that coexistent headers will be overridden.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;
        Specified by:
        getAllowedUpstreamHeadersOrBuilder in interface AuthorizationResponseOrBuilder

      • hasAllowedUpstreamHeadersToAppend

        public boolean hasAllowedUpstreamHeadersToAppend()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that coexistent headers will be appended.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;
        Specified by:
        hasAllowedUpstreamHeadersToAppend in interface AuthorizationResponseOrBuilder
        Returns:
        Whether the allowedUpstreamHeadersToAppend field is set.

      • getAllowedUpstreamHeadersToAppend

        public ListStringMatcher getAllowedUpstreamHeadersToAppend()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that coexistent headers will be appended.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;
        Specified by:
        getAllowedUpstreamHeadersToAppend in interface AuthorizationResponseOrBuilder
        Returns:
        The allowedUpstreamHeadersToAppend.

      • getAllowedUpstreamHeadersToAppendOrBuilder

        public ListStringMatcherOrBuilder getAllowedUpstreamHeadersToAppendOrBuilder()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that coexistent headers will be appended.
        .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;
        Specified by:
        getAllowedUpstreamHeadersToAppendOrBuilder in interface AuthorizationResponseOrBuilder

      • hasAllowedClientHeaders

        public boolean hasAllowedClientHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that when this list is *not* set, all the authorization response headers, except ``Authority
 (Host)`` will be in the response to the client. When a header is included in this list, ``Path``,
 ``Status``, ``Content-Length``, ``WWWAuthenticate`` and ``Location`` are automatically added.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;
        Specified by:
        hasAllowedClientHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        Whether the allowedClientHeaders field is set.

      • getAllowedClientHeaders

        public ListStringMatcher getAllowedClientHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that when this list is *not* set, all the authorization response headers, except ``Authority
 (Host)`` will be in the response to the client. When a header is included in this list, ``Path``,
 ``Status``, ``Content-Length``, ``WWWAuthenticate`` and ``Location`` are automatically added.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;
        Specified by:
        getAllowedClientHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        The allowedClientHeaders.

      • getAllowedClientHeadersOrBuilder

        public ListStringMatcherOrBuilder getAllowedClientHeadersOrBuilder()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response. Note
 that when this list is *not* set, all the authorization response headers, except ``Authority
 (Host)`` will be in the response to the client. When a header is included in this list, ``Path``,
 ``Status``, ``Content-Length``, ``WWWAuthenticate`` and ``Location`` are automatically added.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;
        Specified by:
        getAllowedClientHeadersOrBuilder in interface AuthorizationResponseOrBuilder

      • hasAllowedClientHeadersOnSuccess

        public boolean hasAllowedClientHeadersOnSuccess()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response when
 the authorization response itself is successful, i.e. not failed or denied. When this list is
 *not* set, no additional headers will be added to the client's response on success.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers_on_success = 4;
        Specified by:
        hasAllowedClientHeadersOnSuccess in interface AuthorizationResponseOrBuilder
        Returns:
        Whether the allowedClientHeadersOnSuccess field is set.

      • getAllowedClientHeadersOnSuccess

        public ListStringMatcher getAllowedClientHeadersOnSuccess()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response when
 the authorization response itself is successful, i.e. not failed or denied. When this list is
 *not* set, no additional headers will be added to the client's response on success.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers_on_success = 4;
        Specified by:
        getAllowedClientHeadersOnSuccess in interface AuthorizationResponseOrBuilder
        Returns:
        The allowedClientHeadersOnSuccess.

      • getAllowedClientHeadersOnSuccessOrBuilder

        public ListStringMatcherOrBuilder getAllowedClientHeadersOnSuccessOrBuilder()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. is set, authorization
 response headers that have a correspondent match will be added to the client's response when
 the authorization response itself is successful, i.e. not failed or denied. When this list is
 *not* set, no additional headers will be added to the client's response on success.
        .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers_on_success = 4;
        Specified by:
        getAllowedClientHeadersOnSuccessOrBuilder in interface AuthorizationResponseOrBuilder

      • hasDynamicMetadataFromHeaders

        public boolean hasDynamicMetadataFromHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be emitted as dynamic metadata to be consumed
 by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ext_authz <config_http_filters_ext_authz_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ext_authz <config_network_filters_ext_authz_dynamic_metadata>` for network filter.
        .envoy.type.matcher.v3.ListStringMatcher dynamic_metadata_from_headers = 5;
        Specified by:
        hasDynamicMetadataFromHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        Whether the dynamicMetadataFromHeaders field is set.

      • getDynamicMetadataFromHeaders

        public ListStringMatcher getDynamicMetadataFromHeaders()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be emitted as dynamic metadata to be consumed
 by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ext_authz <config_http_filters_ext_authz_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ext_authz <config_network_filters_ext_authz_dynamic_metadata>` for network filter.
        .envoy.type.matcher.v3.ListStringMatcher dynamic_metadata_from_headers = 5;
        Specified by:
        getDynamicMetadataFromHeaders in interface AuthorizationResponseOrBuilder
        Returns:
        The dynamicMetadataFromHeaders.

      • getDynamicMetadataFromHeadersOrBuilder

        public ListStringMatcherOrBuilder getDynamicMetadataFromHeadersOrBuilder()
         When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
 response headers that have a correspondent match will be emitted as dynamic metadata to be consumed
 by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ext_authz <config_http_filters_ext_authz_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ext_authz <config_network_filters_ext_authz_dynamic_metadata>` for network filter.
        .envoy.type.matcher.v3.ListStringMatcher dynamic_metadata_from_headers = 5;
        Specified by:
        getDynamicMetadataFromHeadersOrBuilder in interface AuthorizationResponseOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AuthorizationResponse parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizationResponse parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizationResponse parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizationResponse parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizationResponse parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AuthorizationResponse parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AuthorizationResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AuthorizationResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AuthorizationResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AuthorizationResponse> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AuthorizationResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder