Package io.envoyproxy.envoy.service.ext_proc.v3

Interface CommonResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CommonResponse, CommonResponse.Builder
    public interface CommonResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getStatusValue

        int getStatusValue()
         If set, provide additional direction on how the Envoy proxy should
 handle the rest of the HTTP filter chain.
        .envoy.service.ext_proc.v3.CommonResponse.ResponseStatus status = 1 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        CommonResponse.ResponseStatus getStatus()
         If set, provide additional direction on how the Envoy proxy should
 handle the rest of the HTTP filter chain.
        .envoy.service.ext_proc.v3.CommonResponse.ResponseStatus status = 1 [(.validate.rules) = { ... }
        Returns:
        The status.

      • hasHeaderMutation

        boolean hasHeaderMutation()
         Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
        .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;
        Returns:
        Whether the headerMutation field is set.

      • getHeaderMutation

        HeaderMutation getHeaderMutation()
         Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
        .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;
        Returns:
        The headerMutation.

      • getHeaderMutationOrBuilder

        HeaderMutationOrBuilder getHeaderMutationOrBuilder()
         Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
        .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;

      • hasBodyMutation

        boolean hasBodyMutation()
         Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
        .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;
        Returns:
        Whether the bodyMutation field is set.

      • getBodyMutation

        BodyMutation getBodyMutation()
         Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
        .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;
        Returns:
        The bodyMutation.

      • getBodyMutationOrBuilder

        BodyMutationOrBuilder getBodyMutationOrBuilder()
         Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
        .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;

      • hasTrailers

        boolean hasTrailers()
         [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The ``trailers`` encoding is based on the runtime guard
 envoy_reloadable_features_send_header_raw_value setting.
 When it is true, the header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
 When it is false, the header value is encoded in the
 :ref:`value <envoy_v3_api_field_config.core.v3.HeaderValue.value>` field.
        .envoy.config.core.v3.HeaderMap trailers = 4;
        Returns:
        Whether the trailers field is set.

      • getTrailers

        HeaderMap getTrailers()
         [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The ``trailers`` encoding is based on the runtime guard
 envoy_reloadable_features_send_header_raw_value setting.
 When it is true, the header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
 When it is false, the header value is encoded in the
 :ref:`value <envoy_v3_api_field_config.core.v3.HeaderValue.value>` field.
        .envoy.config.core.v3.HeaderMap trailers = 4;
        Returns:
        The trailers.

      • getTrailersOrBuilder

        HeaderMapOrBuilder getTrailersOrBuilder()
         [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The ``trailers`` encoding is based on the runtime guard
 envoy_reloadable_features_send_header_raw_value setting.
 When it is true, the header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
 When it is false, the header value is encoded in the
 :ref:`value <envoy_v3_api_field_config.core.v3.HeaderValue.value>` field.
        .envoy.config.core.v3.HeaderMap trailers = 4;

      • getClearRouteCache

        boolean getClearRouteCache()
         Clear the route cache for the current client request. This is necessary
 if the remote server modified headers that are used to calculate the route.
 This field is ignored in the response direction.
        bool clear_route_cache = 5;
        Returns:
        The clearRouteCache.