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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ListStringMatcher getAllowedHeaders()
      Authorization request includes the client request headers that have a correspondent match in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. .. 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.
      ListStringMatcherOrBuilder getAllowedHeadersOrBuilder()
      Authorization request includes the client request headers that have a correspondent match in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. .. 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.
      HeaderValue getHeadersToAdd​(int index)
      Sets a list of headers that will be included to the request to authorization service.
      int getHeadersToAddCount()
      Sets a list of headers that will be included to the request to authorization service.
      List<HeaderValue> getHeadersToAddList()
      Sets a list of headers that will be included to the request to authorization service.
      HeaderValueOrBuilder getHeadersToAddOrBuilder​(int index)
      Sets a list of headers that will be included to the request to authorization service.
      List<? extends HeaderValueOrBuilder> getHeadersToAddOrBuilderList()
      Sets a list of headers that will be included to the request to authorization service.
      boolean hasAllowedHeaders()
      Authorization request includes the client request headers that have a correspondent match in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. .. 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.
      • 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 Detail

      • hasAllowedHeaders

        boolean hasAllowedHeaders()
         Authorization request includes the client request headers that have a correspondent match
         in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
         .. 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;
        Returns:
        Whether the allowedHeaders field is set.
      • getAllowedHeaders

        ListStringMatcher getAllowedHeaders()
         Authorization request includes the client request headers that have a correspondent match
         in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
         .. 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;
        Returns:
        The allowedHeaders.
      • getAllowedHeadersOrBuilder

        ListStringMatcherOrBuilder getAllowedHeadersOrBuilder()
         Authorization request includes the client request headers that have a correspondent match
         in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
         .. 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;
      • getHeadersToAddList

        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;
      • getHeadersToAdd

        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;
      • getHeadersToAddCount

        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;
      • getHeadersToAddOrBuilderList

        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;
      • getHeadersToAddOrBuilder

        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;