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

Class CheckResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.auth.v3.CheckResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CheckResponseOrBuilder, Serializable
public final class CheckResponse extends com.google.protobuf.GeneratedMessageV3 implements CheckResponseOrBuilder
 Intended for gRPC and Network Authorization servers ``only``.
 [#next-free-field: 6]
Protobuf type envoy.service.auth.v3.CheckResponse
See Also:

  • Field Details

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • DENIED_RESPONSE_FIELD_NUMBER

      public static final int DENIED_RESPONSE_FIELD_NUMBER
      See Also:

    • OK_RESPONSE_FIELD_NUMBER

      public static final int OK_RESPONSE_FIELD_NUMBER
      See Also:

    • ERROR_RESPONSE_FIELD_NUMBER

      public static final int ERROR_RESPONSE_FIELD_NUMBER
      See Also:

    • DYNAMIC_METADATA_FIELD_NUMBER

      public static final int DYNAMIC_METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getHttpResponseCase

      public CheckResponse.HttpResponseCase getHttpResponseCase()
      Specified by:
      getHttpResponseCase in interface CheckResponseOrBuilder

    • hasStatus

      public 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;
      Specified by:
      hasStatus in interface CheckResponseOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public 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;
      Specified by:
      getStatus in interface CheckResponseOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public 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;
      Specified by:
      getStatusOrBuilder in interface CheckResponseOrBuilder

    • hasDeniedResponse

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

    • getDeniedResponse

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

    • getDeniedResponseOrBuilder

      public DeniedHttpResponseOrBuilder getDeniedResponseOrBuilder()
       Supplies http attributes for a denied response.
      .envoy.service.auth.v3.DeniedHttpResponse denied_response = 2;
      Specified by:
      getDeniedResponseOrBuilder in interface CheckResponseOrBuilder

    • hasOkResponse

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

    • getOkResponse

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

    • getOkResponseOrBuilder

      public OkHttpResponseOrBuilder getOkResponseOrBuilder()
       Supplies http attributes for an ok response.
      .envoy.service.auth.v3.OkHttpResponse ok_response = 3;
      Specified by:
      getOkResponseOrBuilder in interface CheckResponseOrBuilder

    • hasErrorResponse

      public 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;
      Specified by:
      hasErrorResponse in interface CheckResponseOrBuilder
      Returns:
      Whether the errorResponse field is set.

    • getErrorResponse

      public 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;
      Specified by:
      getErrorResponse in interface CheckResponseOrBuilder
      Returns:
      The errorResponse.

    • getErrorResponseOrBuilder

      public 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;
      Specified by:
      getErrorResponseOrBuilder in interface CheckResponseOrBuilder

    • hasDynamicMetadata

      public 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;
      Specified by:
      hasDynamicMetadata in interface CheckResponseOrBuilder
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      public 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;
      Specified by:
      getDynamicMetadata in interface CheckResponseOrBuilder
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      public 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;
      Specified by:
      getDynamicMetadataOrBuilder in interface CheckResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CheckResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CheckResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CheckResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CheckResponse.Builder newBuilder()

    • newBuilder

      public static CheckResponse.Builder newBuilder(CheckResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CheckResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CheckResponse> parser()

    • getParserForType

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