Package io.envoyproxy.envoy.service.auth.v3

Interface CheckResponseOrBuilder

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

  • Method Details

    • hasStatus

      boolean hasStatus()
       Status ``OK`` allows the request. Any other status indicates the request should be denied, and
 for HTTP filter, if not overridden by :ref:`denied HTTP response status <envoy_v3_api_field_service.auth.v3.DeniedHttpResponse.status>`
 Envoy sends ``403 Forbidden`` HTTP status code by default.
      .google.rpc.Status status = 1;
      Returns:
      Whether the status field is set.

    • getStatus

      Status getStatus()
       Status ``OK`` allows the request. Any other status indicates the request should be denied, and
 for HTTP filter, if not overridden by :ref:`denied HTTP response status <envoy_v3_api_field_service.auth.v3.DeniedHttpResponse.status>`
 Envoy sends ``403 Forbidden`` HTTP status code by default.
      .google.rpc.Status status = 1;
      Returns:
      The status.

    • getStatusOrBuilder

      StatusOrBuilder getStatusOrBuilder()
       Status ``OK`` allows the request. Any other status indicates the request should be denied, and
 for HTTP filter, if not overridden by :ref:`denied HTTP response status <envoy_v3_api_field_service.auth.v3.DeniedHttpResponse.status>`
 Envoy sends ``403 Forbidden`` HTTP status code by default.
      .google.rpc.Status status = 1;

    • hasDeniedResponse

      boolean hasDeniedResponse()
       Supplies http attributes for a denied response.
      .envoy.service.auth.v3.DeniedHttpResponse denied_response = 2;
      Returns:
      Whether the deniedResponse field is set.

    • getDeniedResponse

      DeniedHttpResponse getDeniedResponse()
       Supplies http attributes for a denied response.
      .envoy.service.auth.v3.DeniedHttpResponse denied_response = 2;
      Returns:
      The deniedResponse.

    • getDeniedResponseOrBuilder

      DeniedHttpResponseOrBuilder getDeniedResponseOrBuilder()
       Supplies http attributes for a denied response.
      .envoy.service.auth.v3.DeniedHttpResponse denied_response = 2;

    • hasOkResponse

      boolean hasOkResponse()
       Supplies http attributes for an ok response.
      .envoy.service.auth.v3.OkHttpResponse ok_response = 3;
      Returns:
      Whether the okResponse field is set.

    • getOkResponse

      OkHttpResponse getOkResponse()
       Supplies http attributes for an ok response.
      .envoy.service.auth.v3.OkHttpResponse ok_response = 3;
      Returns:
      The okResponse.

    • getOkResponseOrBuilder

      OkHttpResponseOrBuilder getOkResponseOrBuilder()
       Supplies http attributes for an ok response.
      .envoy.service.auth.v3.OkHttpResponse ok_response = 3;

    • hasErrorResponse

      boolean hasErrorResponse()
       Supplies http attributes for an error response. This is used when the authorization
 service encounters an internal error and wants to return custom headers and body to the
 downstream client. When ``error_response`` is set, the ext_authz filter increments the
 ``ext_authz_error`` stat and respects the :ref:`failure_mode_allow
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.failure_mode_allow>`
 configuration. The HTTP status code, headers, and body are taken from the
 :ref:`DeniedHttpResponse <envoy_v3_api_msg_service.auth.v3.DeniedHttpResponse>` message.
 If the status field is not set, Envoy sends the status code configured via
 :ref:`status_on_error <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.status_on_error>`,
 which defaults to ``403 Forbidden``.
      .envoy.service.auth.v3.DeniedHttpResponse error_response = 5;
      Returns:
      Whether the errorResponse field is set.

    • getErrorResponse

      DeniedHttpResponse getErrorResponse()
       Supplies http attributes for an error response. This is used when the authorization
 service encounters an internal error and wants to return custom headers and body to the
 downstream client. When ``error_response`` is set, the ext_authz filter increments the
 ``ext_authz_error`` stat and respects the :ref:`failure_mode_allow
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.failure_mode_allow>`
 configuration. The HTTP status code, headers, and body are taken from the
 :ref:`DeniedHttpResponse <envoy_v3_api_msg_service.auth.v3.DeniedHttpResponse>` message.
 If the status field is not set, Envoy sends the status code configured via
 :ref:`status_on_error <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.status_on_error>`,
 which defaults to ``403 Forbidden``.
      .envoy.service.auth.v3.DeniedHttpResponse error_response = 5;
      Returns:
      The errorResponse.

    • getErrorResponseOrBuilder

      DeniedHttpResponseOrBuilder getErrorResponseOrBuilder()
       Supplies http attributes for an error response. This is used when the authorization
 service encounters an internal error and wants to return custom headers and body to the
 downstream client. When ``error_response`` is set, the ext_authz filter increments the
 ``ext_authz_error`` stat and respects the :ref:`failure_mode_allow
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.failure_mode_allow>`
 configuration. The HTTP status code, headers, and body are taken from the
 :ref:`DeniedHttpResponse <envoy_v3_api_msg_service.auth.v3.DeniedHttpResponse>` message.
 If the status field is not set, Envoy sends the status code configured via
 :ref:`status_on_error <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.status_on_error>`,
 which defaults to ``403 Forbidden``.
      .envoy.service.auth.v3.DeniedHttpResponse error_response = 5;

    • hasDynamicMetadata

      boolean hasDynamicMetadata()
       Optional response metadata that 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.
      .google.protobuf.Struct dynamic_metadata = 4;
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      com.google.protobuf.Struct getDynamicMetadata()
       Optional response metadata that 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.
      .google.protobuf.Struct dynamic_metadata = 4;
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
       Optional response metadata that 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.
      .google.protobuf.Struct dynamic_metadata = 4;

    • getHttpResponseCase

      CheckResponse.HttpResponseCase getHttpResponseCase()