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

Class AuthorizationRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AuthorizationRequestOrBuilder, Serializable
    public final class AuthorizationRequest
extends com.google.protobuf.GeneratedMessageV3
implements AuthorizationRequestOrBuilder
    Protobuf type envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest
    See Also:
    Serialized Form

    • Field Detail

      • ALLOWED_HEADERS_FIELD_NUMBER

        public static final int ALLOWED_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEADERS_TO_ADD_FIELD_NUMBER

        public static final int HEADERS_TO_ADD_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

      • hasAllowedHeaders

        @Deprecated
public boolean hasAllowedHeaders()
        Deprecated.
        envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers is deprecated. See envoy/extensions/filters/http/ext_authz/v3/ext_authz.proto;l=293
         Authorization request includes the client request headers that have a correspondent match
 in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
 This field has been deprecated in favor of :ref:`allowed_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.allowed_headers>`.
 .. note::
   In addition to the the user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** to the list.
 .. note::
   By default, ``Content-Length`` header is set to ``0`` and the request to the authorization
   service has no message body. However, the authorization request *may* include the buffered
   client request body (controlled by :ref:`with_request_body
   <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
   setting) hence the value of its ``Content-Length`` reflects the size of its payload size.
        .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasAllowedHeaders in interface AuthorizationRequestOrBuilder
        Returns:
        Whether the allowedHeaders field is set.

      • getAllowedHeaders

        @Deprecated
public ListStringMatcher getAllowedHeaders()
        Deprecated.
        envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers is deprecated. See envoy/extensions/filters/http/ext_authz/v3/ext_authz.proto;l=293
         Authorization request includes the client request headers that have a correspondent match
 in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
 This field has been deprecated in favor of :ref:`allowed_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.allowed_headers>`.
 .. note::
   In addition to the the user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** to the list.
 .. note::
   By default, ``Content-Length`` header is set to ``0`` and the request to the authorization
   service has no message body. However, the authorization request *may* include the buffered
   client request body (controlled by :ref:`with_request_body
   <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
   setting) hence the value of its ``Content-Length`` reflects the size of its payload size.
        .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getAllowedHeaders in interface AuthorizationRequestOrBuilder
        Returns:
        The allowedHeaders.

      • getAllowedHeadersOrBuilder

        @Deprecated
public ListStringMatcherOrBuilder getAllowedHeadersOrBuilder()
        Deprecated.
         Authorization request includes the client request headers that have a correspondent match
 in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
 This field has been deprecated in favor of :ref:`allowed_headers
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.allowed_headers>`.
 .. note::
   In addition to the the user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** to the list.
 .. note::
   By default, ``Content-Length`` header is set to ``0`` and the request to the authorization
   service has no message body. However, the authorization request *may* include the buffered
   client request body (controlled by :ref:`with_request_body
   <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
   setting) hence the value of its ``Content-Length`` reflects the size of its payload size.
        .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getAllowedHeadersOrBuilder in interface AuthorizationRequestOrBuilder

      • getHeadersToAddList

        public List<HeaderValue> getHeadersToAddList()
         Sets a list of headers that will be included to the request to authorization service. Note that
 client request of the same key will be overridden.
        repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;
        Specified by:
        getHeadersToAddList in interface AuthorizationRequestOrBuilder

      • getHeadersToAddOrBuilderList

        public List<? extends HeaderValueOrBuilder> getHeadersToAddOrBuilderList()
         Sets a list of headers that will be included to the request to authorization service. Note that
 client request of the same key will be overridden.
        repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;
        Specified by:
        getHeadersToAddOrBuilderList in interface AuthorizationRequestOrBuilder

      • getHeadersToAddCount

        public int getHeadersToAddCount()
         Sets a list of headers that will be included to the request to authorization service. Note that
 client request of the same key will be overridden.
        repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;
        Specified by:
        getHeadersToAddCount in interface AuthorizationRequestOrBuilder

      • getHeadersToAdd

        public HeaderValue getHeadersToAdd​(int index)
         Sets a list of headers that will be included to the request to authorization service. Note that
 client request of the same key will be overridden.
        repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;
        Specified by:
        getHeadersToAdd in interface AuthorizationRequestOrBuilder

      • getHeadersToAddOrBuilder

        public HeaderValueOrBuilder getHeadersToAddOrBuilder​(int index)
         Sets a list of headers that will be included to the request to authorization service. Note that
 client request of the same key will be overridden.
        repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;
        Specified by:
        getHeadersToAddOrBuilder in interface AuthorizationRequestOrBuilder

      • 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 AuthorizationRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AuthorizationRequest> 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 AuthorizationRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder