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 Summary

    Modifier and Type
    Method
    Description
    BodyMutation
    getBodyMutation()
    Replace the body of the last message sent to the remote server on this stream.
    BodyMutationOrBuilder
    getBodyMutationOrBuilder()
    Replace the body of the last message sent to the remote server on this stream.
    boolean
    getClearRouteCache()
    Clear the route cache for the current client request.
    HeaderMutation
    getHeaderMutation()
    Instructions on how to manipulate the headers.
    HeaderMutationOrBuilder
    getHeaderMutationOrBuilder()
    Instructions on how to manipulate the headers.
    CommonResponse.ResponseStatus
    getStatus()
    If set, provide additional direction on how the data plane should handle the rest of the HTTP filter chain.
    int
    getStatusValue()
    If set, provide additional direction on how the data plane should handle the rest of the HTTP filter chain.
    HeaderMap
    getTrailers()
    [#not-implemented-hide:] Add new trailers to the message.
    HeaderMapOrBuilder
    getTrailersOrBuilder()
    [#not-implemented-hide:] Add new trailers to the message.
    boolean
    hasBodyMutation()
    Replace the body of the last message sent to the remote server on this stream.
    boolean
    hasHeaderMutation()
    Instructions on how to manipulate the headers.
    boolean
    hasTrailers()
    [#not-implemented-hide:] Add new trailers to the message.

    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

    • getStatusValue

      int getStatusValue()
       If set, provide additional direction on how the data plane 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 data plane 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 header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_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 header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_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 header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_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. This field is also ignored
 if the data plane ext_proc filter is in the upstream filter chain.
      bool clear_route_cache = 5;
      Returns:
      The clearRouteCache.