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

Interface AuthorizationResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    ListStringMatcher
    getAllowedClientHeaders()
    When this list is set, authorization response headers that have a correspondent match will be added to the client's response.
    ListStringMatcher
    getAllowedClientHeadersOnSuccess()
    When this list 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.
    ListStringMatcherOrBuilder
    getAllowedClientHeadersOnSuccessOrBuilder()
    When this list 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.
    ListStringMatcherOrBuilder
    getAllowedClientHeadersOrBuilder()
    When this list is set, authorization response headers that have a correspondent match will be added to the client's response.
    ListStringMatcher
    getAllowedUpstreamHeaders()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be overridden.
    ListStringMatcherOrBuilder
    getAllowedUpstreamHeadersOrBuilder()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be overridden.
    ListStringMatcher
    getAllowedUpstreamHeadersToAppend()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be appended.
    ListStringMatcherOrBuilder
    getAllowedUpstreamHeadersToAppendOrBuilder()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be appended.
    ListStringMatcher
    getDynamicMetadataFromHeaders()
    When this list is set, authorization response headers that have a correspondent match will be emitted as dynamic metadata to be consumed by the next filter.
    ListStringMatcherOrBuilder
    getDynamicMetadataFromHeadersOrBuilder()
    When this list is set, authorization response headers that have a correspondent match will be emitted as dynamic metadata to be consumed by the next filter.
    boolean
    hasAllowedClientHeaders()
    When this list is set, authorization response headers that have a correspondent match will be added to the client's response.
    boolean
    hasAllowedClientHeadersOnSuccess()
    When this list 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.
    boolean
    hasAllowedUpstreamHeaders()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be overridden.
    boolean
    hasAllowedUpstreamHeadersToAppend()
    When this list is set, authorization response headers that have a correspondent match will be added to the original client request. .. note:: Existing headers will be appended.
    boolean
    hasDynamicMetadataFromHeaders()
    When this list is set, authorization response headers that have a correspondent match will be emitted as dynamic metadata to be consumed by the next filter.

    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

    • hasAllowedUpstreamHeaders

      boolean hasAllowedUpstreamHeaders()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be overridden.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;
      Returns:
      Whether the allowedUpstreamHeaders field is set.

    • getAllowedUpstreamHeaders

      ListStringMatcher getAllowedUpstreamHeaders()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be overridden.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;
      Returns:
      The allowedUpstreamHeaders.

    • getAllowedUpstreamHeadersOrBuilder

      ListStringMatcherOrBuilder getAllowedUpstreamHeadersOrBuilder()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be overridden.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers = 1;

    • hasAllowedUpstreamHeadersToAppend

      boolean hasAllowedUpstreamHeadersToAppend()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be appended.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;
      Returns:
      Whether the allowedUpstreamHeadersToAppend field is set.

    • getAllowedUpstreamHeadersToAppend

      ListStringMatcher getAllowedUpstreamHeadersToAppend()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be appended.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;
      Returns:
      The allowedUpstreamHeadersToAppend.

    • getAllowedUpstreamHeadersToAppendOrBuilder

      ListStringMatcherOrBuilder getAllowedUpstreamHeadersToAppendOrBuilder()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the original client request.

 .. note::
   Existing headers will be appended.
      .envoy.type.matcher.v3.ListStringMatcher allowed_upstream_headers_to_append = 3;

    • hasAllowedClientHeaders

      boolean hasAllowedClientHeaders()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the client's response.
 When a header is included in this list, ``Path``, ``Status``, ``Content-Length``, ``WWW-Authenticate`` and
 ``Location`` are automatically added.

 .. note::
   When this list is *not* set, all the authorization response headers, except
   ``Authority (Host)``, will be in the response to the client.
      .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;
      Returns:
      Whether the allowedClientHeaders field is set.

    • getAllowedClientHeaders

      ListStringMatcher getAllowedClientHeaders()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the client's response.
 When a header is included in this list, ``Path``, ``Status``, ``Content-Length``, ``WWW-Authenticate`` and
 ``Location`` are automatically added.

 .. note::
   When this list is *not* set, all the authorization response headers, except
   ``Authority (Host)``, will be in the response to the client.
      .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;
      Returns:
      The allowedClientHeaders.

    • getAllowedClientHeadersOrBuilder

      ListStringMatcherOrBuilder getAllowedClientHeadersOrBuilder()
       When this list is set, authorization
 response headers that have a correspondent match will be added to the client's response.
 When a header is included in this list, ``Path``, ``Status``, ``Content-Length``, ``WWW-Authenticate`` and
 ``Location`` are automatically added.

 .. note::
   When this list is *not* set, all the authorization response headers, except
   ``Authority (Host)``, will be in the response to the client.
      .envoy.type.matcher.v3.ListStringMatcher allowed_client_headers = 2;

    • hasAllowedClientHeadersOnSuccess

      boolean hasAllowedClientHeadersOnSuccess()
       When this list 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;
      Returns:
      Whether the allowedClientHeadersOnSuccess field is set.

    • getAllowedClientHeadersOnSuccess

      ListStringMatcher getAllowedClientHeadersOnSuccess()
       When this list 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;
      Returns:
      The allowedClientHeadersOnSuccess.

    • getAllowedClientHeadersOnSuccessOrBuilder

      ListStringMatcherOrBuilder getAllowedClientHeadersOnSuccessOrBuilder()
       When this list 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;

    • hasDynamicMetadataFromHeaders

      boolean hasDynamicMetadataFromHeaders()
       When this list 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;
      Returns:
      Whether the dynamicMetadataFromHeaders field is set.

    • getDynamicMetadataFromHeaders

      ListStringMatcher getDynamicMetadataFromHeaders()
       When this list 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;
      Returns:
      The dynamicMetadataFromHeaders.

    • getDynamicMetadataFromHeadersOrBuilder

      ListStringMatcherOrBuilder getDynamicMetadataFromHeadersOrBuilder()
       When this list 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;