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

Interface AuthorizationRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthorizationRequest, AuthorizationRequest.Builder
public interface AuthorizationRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ListStringMatcher
    getAllowedHeaders()
    Deprecated.
    envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers is deprecated.
    ListStringMatcherOrBuilder
    getAllowedHeadersOrBuilder()
    Deprecated.
    HeaderValue
    getHeadersToAdd(int index)
    Sets a list of headers that will be included in the request to the authorization service. .. note:: Client request headers with the same key will be overridden.
    int
    getHeadersToAddCount()
    Sets a list of headers that will be included in the request to the authorization service. .. note:: Client request headers with the same key will be overridden.
    List<HeaderValue>
    getHeadersToAddList()
    Sets a list of headers that will be included in the request to the authorization service. .. note:: Client request headers with the same key will be overridden.
    HeaderValueOrBuilder
    getHeadersToAddOrBuilder(int index)
    Sets a list of headers that will be included in the request to the authorization service. .. note:: Client request headers with the same key will be overridden.
    List<? extends HeaderValueOrBuilder>
    getHeadersToAddOrBuilderList()
    Sets a list of headers that will be included in the request to the authorization service. .. note:: Client request headers with the same key will be overridden.
    boolean
    hasAllowedHeaders()
    Deprecated.
    envoy.extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers is deprecated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasAllowedHeaders

      @Deprecated 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=477
       Authorization request includes the client request headers that have a corresponding match
 in the list.
 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 user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** in the list.

 .. note::

   By default, the ``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.
      .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the allowedHeaders field is set.

    • getAllowedHeaders

      @Deprecated 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=477
       Authorization request includes the client request headers that have a corresponding match
 in the list.
 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 user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** in the list.

 .. note::

   By default, the ``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.
      .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The allowedHeaders.

    • getAllowedHeadersOrBuilder

      @Deprecated ListStringMatcherOrBuilder getAllowedHeadersOrBuilder()
      Deprecated.
       Authorization request includes the client request headers that have a corresponding match
 in the list.
 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 user's supplied matchers, ``Host``, ``Method``, ``Path``,
   ``Content-Length``, and ``Authorization`` are **automatically included** in the list.

 .. note::

   By default, the ``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.
      .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getHeadersToAddList

      List<HeaderValue> getHeadersToAddList()
       Sets a list of headers that will be included in the request to the authorization service.

 .. note::
   Client request headers with the same key will be overridden.
      repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;

    • getHeadersToAdd

      HeaderValue getHeadersToAdd(int index)
       Sets a list of headers that will be included in the request to the authorization service.

 .. note::
   Client request headers with the same key will be overridden.
      repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;

    • getHeadersToAddCount

      int getHeadersToAddCount()
       Sets a list of headers that will be included in the request to the authorization service.

 .. note::
   Client request headers with the same key will be overridden.
      repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;

    • getHeadersToAddOrBuilderList

      List<? extends HeaderValueOrBuilder> getHeadersToAddOrBuilderList()
       Sets a list of headers that will be included in the request to the authorization service.

 .. note::
   Client request headers with the same key will be overridden.
      repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;

    • getHeadersToAddOrBuilder

      HeaderValueOrBuilder getHeadersToAddOrBuilder(int index)
       Sets a list of headers that will be included in the request to the authorization service.

 .. note::
   Client request headers with the same key will be overridden.
      repeated .envoy.config.core.v3.HeaderValue headers_to_add = 2;