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

Interface ProcessingResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    getDynamicMetadata()
    Optional metadata that will be emitted as dynamic metadata to be consumed by following filters.
    com.google.protobuf.StructOrBuilder
    getDynamicMetadataOrBuilder()
    Optional metadata that will be emitted as dynamic metadata to be consumed by following filters.
    ImmediateResponse
    getImmediateResponse()
    If specified, attempt to create a locally generated response, send it downstream, and stop processing additional filters and ignore any additional messages received from the remote server for this request or response.
    ImmediateResponseOrBuilder
    getImmediateResponseOrBuilder()
    If specified, attempt to create a locally generated response, send it downstream, and stop processing additional filters and ignore any additional messages received from the remote server for this request or response.
    ProcessingMode
    getModeOverride()
    Override how parts of the HTTP request and response are processed for the duration of this particular request/response only.
    ProcessingModeOrBuilder
    getModeOverrideOrBuilder()
    Override how parts of the HTTP request and response are processed for the duration of this particular request/response only.
    com.google.protobuf.Duration
    getOverrideMessageTimeout()
    When ext_proc server receives a request message, in case it needs more time to process the message, it sends back a ProcessingResponse message with a new timeout value.
    com.google.protobuf.DurationOrBuilder
    getOverrideMessageTimeoutOrBuilder()
    When ext_proc server receives a request message, in case it needs more time to process the message, it sends back a ProcessingResponse message with a new timeout value.
    BodyResponse
    getRequestBody()
    The server must send back this message in response to a message with the ``request_body`` field set.
    BodyResponseOrBuilder
    getRequestBodyOrBuilder()
    The server must send back this message in response to a message with the ``request_body`` field set.
    boolean
    getRequestDrain()
    [#not-implemented-hide:] Used only in ``FULL_DUPLEX_STREAMED`` and ``GRPC`` body send modes.
    HeadersResponse
    getRequestHeaders()
    The server must send back this message in response to a message with the ``request_headers`` field set.
    HeadersResponseOrBuilder
    getRequestHeadersOrBuilder()
    The server must send back this message in response to a message with the ``request_headers`` field set.
    TrailersResponse
    getRequestTrailers()
    The server must send back this message in response to a message with the ``request_trailers`` field set.
    TrailersResponseOrBuilder
    getRequestTrailersOrBuilder()
    The server must send back this message in response to a message with the ``request_trailers`` field set.
    BodyResponse
    getResponseBody()
    The server must send back this message in response to a message with the ``response_body`` field set.
    BodyResponseOrBuilder
    getResponseBodyOrBuilder()
    The server must send back this message in response to a message with the ``response_body`` field set.
    ProcessingResponse.ResponseCase
    getResponseCase()
     
    HeadersResponse
    getResponseHeaders()
    The server must send back this message in response to a message with the ``response_headers`` field set.
    HeadersResponseOrBuilder
    getResponseHeadersOrBuilder()
    The server must send back this message in response to a message with the ``response_headers`` field set.
    TrailersResponse
    getResponseTrailers()
    The server must send back this message in response to a message with the ``response_trailers`` field set.
    TrailersResponseOrBuilder
    getResponseTrailersOrBuilder()
    The server must send back this message in response to a message with the ``response_trailers`` field set.
    StreamedImmediateResponse
    getStreamedImmediateResponse()
    The server sends back this message to initiate or continue local response streaming.
    StreamedImmediateResponseOrBuilder
    getStreamedImmediateResponseOrBuilder()
    The server sends back this message to initiate or continue local response streaming.
    boolean
    hasDynamicMetadata()
    Optional metadata that will be emitted as dynamic metadata to be consumed by following filters.
    boolean
    hasImmediateResponse()
    If specified, attempt to create a locally generated response, send it downstream, and stop processing additional filters and ignore any additional messages received from the remote server for this request or response.
    boolean
    hasModeOverride()
    Override how parts of the HTTP request and response are processed for the duration of this particular request/response only.
    boolean
    hasOverrideMessageTimeout()
    When ext_proc server receives a request message, in case it needs more time to process the message, it sends back a ProcessingResponse message with a new timeout value.
    boolean
    hasRequestBody()
    The server must send back this message in response to a message with the ``request_body`` field set.
    boolean
    hasRequestHeaders()
    The server must send back this message in response to a message with the ``request_headers`` field set.
    boolean
    hasRequestTrailers()
    The server must send back this message in response to a message with the ``request_trailers`` field set.
    boolean
    hasResponseBody()
    The server must send back this message in response to a message with the ``response_body`` field set.
    boolean
    hasResponseHeaders()
    The server must send back this message in response to a message with the ``response_headers`` field set.
    boolean
    hasResponseTrailers()
    The server must send back this message in response to a message with the ``response_trailers`` field set.
    boolean
    hasStreamedImmediateResponse()
    The server sends back this message to initiate or continue local response streaming.

    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

    • hasRequestHeaders

      boolean hasRequestHeaders()
       The server must send back this message in response to a message with the
 ``request_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse request_headers = 1;
      Returns:
      Whether the requestHeaders field is set.

    • getRequestHeaders

      HeadersResponse getRequestHeaders()
       The server must send back this message in response to a message with the
 ``request_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse request_headers = 1;
      Returns:
      The requestHeaders.

    • getRequestHeadersOrBuilder

      HeadersResponseOrBuilder getRequestHeadersOrBuilder()
       The server must send back this message in response to a message with the
 ``request_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse request_headers = 1;

    • hasResponseHeaders

      boolean hasResponseHeaders()
       The server must send back this message in response to a message with the
 ``response_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse response_headers = 2;
      Returns:
      Whether the responseHeaders field is set.

    • getResponseHeaders

      HeadersResponse getResponseHeaders()
       The server must send back this message in response to a message with the
 ``response_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse response_headers = 2;
      Returns:
      The responseHeaders.

    • getResponseHeadersOrBuilder

      HeadersResponseOrBuilder getResponseHeadersOrBuilder()
       The server must send back this message in response to a message with the
 ``response_headers`` field set.
      .envoy.service.ext_proc.v3.HeadersResponse response_headers = 2;

    • hasRequestBody

      boolean hasRequestBody()
       The server must send back this message in response to a message with
 the ``request_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse request_body = 3;
      Returns:
      Whether the requestBody field is set.

    • getRequestBody

      BodyResponse getRequestBody()
       The server must send back this message in response to a message with
 the ``request_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse request_body = 3;
      Returns:
      The requestBody.

    • getRequestBodyOrBuilder

      BodyResponseOrBuilder getRequestBodyOrBuilder()
       The server must send back this message in response to a message with
 the ``request_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse request_body = 3;

    • hasResponseBody

      boolean hasResponseBody()
       The server must send back this message in response to a message with
 the ``response_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse response_body = 4;
      Returns:
      Whether the responseBody field is set.

    • getResponseBody

      BodyResponse getResponseBody()
       The server must send back this message in response to a message with
 the ``response_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse response_body = 4;
      Returns:
      The responseBody.

    • getResponseBodyOrBuilder

      BodyResponseOrBuilder getResponseBodyOrBuilder()
       The server must send back this message in response to a message with
 the ``response_body`` field set.
      .envoy.service.ext_proc.v3.BodyResponse response_body = 4;

    • hasRequestTrailers

      boolean hasRequestTrailers()
       The server must send back this message in response to a message with
 the ``request_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse request_trailers = 5;
      Returns:
      Whether the requestTrailers field is set.

    • getRequestTrailers

      TrailersResponse getRequestTrailers()
       The server must send back this message in response to a message with
 the ``request_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse request_trailers = 5;
      Returns:
      The requestTrailers.

    • getRequestTrailersOrBuilder

      TrailersResponseOrBuilder getRequestTrailersOrBuilder()
       The server must send back this message in response to a message with
 the ``request_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse request_trailers = 5;

    • hasResponseTrailers

      boolean hasResponseTrailers()
       The server must send back this message in response to a message with
 the ``response_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse response_trailers = 6;
      Returns:
      Whether the responseTrailers field is set.

    • getResponseTrailers

      TrailersResponse getResponseTrailers()
       The server must send back this message in response to a message with
 the ``response_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse response_trailers = 6;
      Returns:
      The responseTrailers.

    • getResponseTrailersOrBuilder

      TrailersResponseOrBuilder getResponseTrailersOrBuilder()
       The server must send back this message in response to a message with
 the ``response_trailers`` field set.
      .envoy.service.ext_proc.v3.TrailersResponse response_trailers = 6;

    • hasImmediateResponse

      boolean hasImmediateResponse()
       If specified, attempt to create a locally generated response, send it
 downstream, and stop processing additional filters and ignore any
 additional messages received from the remote server for this request or
 response. If a response has already started -- for example, if this
 message is sent response to a ``response_body`` message -- then
 this will either ship the reply directly to the downstream codec,
 or reset the stream.
      .envoy.service.ext_proc.v3.ImmediateResponse immediate_response = 7;
      Returns:
      Whether the immediateResponse field is set.

    • getImmediateResponse

      ImmediateResponse getImmediateResponse()
       If specified, attempt to create a locally generated response, send it
 downstream, and stop processing additional filters and ignore any
 additional messages received from the remote server for this request or
 response. If a response has already started -- for example, if this
 message is sent response to a ``response_body`` message -- then
 this will either ship the reply directly to the downstream codec,
 or reset the stream.
      .envoy.service.ext_proc.v3.ImmediateResponse immediate_response = 7;
      Returns:
      The immediateResponse.

    • getImmediateResponseOrBuilder

      ImmediateResponseOrBuilder getImmediateResponseOrBuilder()
       If specified, attempt to create a locally generated response, send it
 downstream, and stop processing additional filters and ignore any
 additional messages received from the remote server for this request or
 response. If a response has already started -- for example, if this
 message is sent response to a ``response_body`` message -- then
 this will either ship the reply directly to the downstream codec,
 or reset the stream.
      .envoy.service.ext_proc.v3.ImmediateResponse immediate_response = 7;

    • hasStreamedImmediateResponse

      boolean hasStreamedImmediateResponse()
       The server sends back this message to initiate or continue local response streaming.
 The server must initiate local response streaming with the ``headers_response`` in response to a ProcessingRequest
 with the ``request_headers`` only.
 The server may follow up with multiple messages containing ``body_response``. The server must indicate
 end of stream by setting ``end_of_stream`` to ``true`` in the ``headers_response``
 or ``body_response`` message or by sending a ``trailers_response`` message.
 The client may send a ``request_body`` or ``request_trailers`` to the server depending on configuration.
 The streaming local response can only be sent when the ``request_header_mode`` in the filter
 :ref:`processing_mode <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>`
 is set to ``SEND``. The ext_proc server should not send StreamedImmediateResponse if it did not observe request headers,
 as it will result in the race with the upstream server response and reset of the client request.
 Presently only the FULL_DUPLEX_STREAMED or NONE body modes are supported.
      .envoy.service.ext_proc.v3.StreamedImmediateResponse streamed_immediate_response = 11;
      Returns:
      Whether the streamedImmediateResponse field is set.

    • getStreamedImmediateResponse

      StreamedImmediateResponse getStreamedImmediateResponse()
       The server sends back this message to initiate or continue local response streaming.
 The server must initiate local response streaming with the ``headers_response`` in response to a ProcessingRequest
 with the ``request_headers`` only.
 The server may follow up with multiple messages containing ``body_response``. The server must indicate
 end of stream by setting ``end_of_stream`` to ``true`` in the ``headers_response``
 or ``body_response`` message or by sending a ``trailers_response`` message.
 The client may send a ``request_body`` or ``request_trailers`` to the server depending on configuration.
 The streaming local response can only be sent when the ``request_header_mode`` in the filter
 :ref:`processing_mode <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>`
 is set to ``SEND``. The ext_proc server should not send StreamedImmediateResponse if it did not observe request headers,
 as it will result in the race with the upstream server response and reset of the client request.
 Presently only the FULL_DUPLEX_STREAMED or NONE body modes are supported.
      .envoy.service.ext_proc.v3.StreamedImmediateResponse streamed_immediate_response = 11;
      Returns:
      The streamedImmediateResponse.

    • getStreamedImmediateResponseOrBuilder

      StreamedImmediateResponseOrBuilder getStreamedImmediateResponseOrBuilder()
       The server sends back this message to initiate or continue local response streaming.
 The server must initiate local response streaming with the ``headers_response`` in response to a ProcessingRequest
 with the ``request_headers`` only.
 The server may follow up with multiple messages containing ``body_response``. The server must indicate
 end of stream by setting ``end_of_stream`` to ``true`` in the ``headers_response``
 or ``body_response`` message or by sending a ``trailers_response`` message.
 The client may send a ``request_body`` or ``request_trailers`` to the server depending on configuration.
 The streaming local response can only be sent when the ``request_header_mode`` in the filter
 :ref:`processing_mode <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>`
 is set to ``SEND``. The ext_proc server should not send StreamedImmediateResponse if it did not observe request headers,
 as it will result in the race with the upstream server response and reset of the client request.
 Presently only the FULL_DUPLEX_STREAMED or NONE body modes are supported.
      .envoy.service.ext_proc.v3.StreamedImmediateResponse streamed_immediate_response = 11;

    • hasDynamicMetadata

      boolean hasDynamicMetadata()
       Optional metadata that will be emitted as dynamic metadata to be consumed by
 following filters. This metadata will be placed in the namespace(s) specified by the top-level
 field name(s) of the struct.
      .google.protobuf.Struct dynamic_metadata = 8;
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      com.google.protobuf.Struct getDynamicMetadata()
       Optional metadata that will be emitted as dynamic metadata to be consumed by
 following filters. This metadata will be placed in the namespace(s) specified by the top-level
 field name(s) of the struct.
      .google.protobuf.Struct dynamic_metadata = 8;
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
       Optional metadata that will be emitted as dynamic metadata to be consumed by
 following filters. This metadata will be placed in the namespace(s) specified by the top-level
 field name(s) of the struct.
      .google.protobuf.Struct dynamic_metadata = 8;

    • hasModeOverride

      boolean hasModeOverride()
       Override how parts of the HTTP request and response are processed
 for the duration of this particular request/response only. Servers
 may use this to intelligently control how requests are processed
 based on the headers and other metadata that they see.
 This field is only applicable when servers responding to the header requests.
 If it is set in the response to the body or trailer requests, it will be ignored by the data plane.
 It is also ignored by the data plane when the ext_proc filter config
 :ref:`allow_mode_override
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.allow_mode_override>`
 is set to false, or
 :ref:`send_body_without_waiting_for_header_response
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.send_body_without_waiting_for_header_response>`
 is set to true.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode mode_override = 9;
      Returns:
      Whether the modeOverride field is set.

    • getModeOverride

      ProcessingMode getModeOverride()
       Override how parts of the HTTP request and response are processed
 for the duration of this particular request/response only. Servers
 may use this to intelligently control how requests are processed
 based on the headers and other metadata that they see.
 This field is only applicable when servers responding to the header requests.
 If it is set in the response to the body or trailer requests, it will be ignored by the data plane.
 It is also ignored by the data plane when the ext_proc filter config
 :ref:`allow_mode_override
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.allow_mode_override>`
 is set to false, or
 :ref:`send_body_without_waiting_for_header_response
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.send_body_without_waiting_for_header_response>`
 is set to true.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode mode_override = 9;
      Returns:
      The modeOverride.

    • getModeOverrideOrBuilder

      ProcessingModeOrBuilder getModeOverrideOrBuilder()
       Override how parts of the HTTP request and response are processed
 for the duration of this particular request/response only. Servers
 may use this to intelligently control how requests are processed
 based on the headers and other metadata that they see.
 This field is only applicable when servers responding to the header requests.
 If it is set in the response to the body or trailer requests, it will be ignored by the data plane.
 It is also ignored by the data plane when the ext_proc filter config
 :ref:`allow_mode_override
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.allow_mode_override>`
 is set to false, or
 :ref:`send_body_without_waiting_for_header_response
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.send_body_without_waiting_for_header_response>`
 is set to true.
      .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode mode_override = 9;

    • getRequestDrain

      boolean getRequestDrain()
       [#not-implemented-hide:]
 Used only in ``FULL_DUPLEX_STREAMED`` and ``GRPC`` body send modes.
 Instructs the data plane to stop sending body data and to send a
 half-close on the ext_proc stream. The ext_proc server should then echo
 back all subsequent body contents as-is until it sees the client's
 half-close, at which point the ext_proc server can terminate the stream
 with an OK status. This provides a safe way for the ext_proc server
 to indicate that it does not need to see the rest of the stream;
 without this, the ext_proc server could not terminate the stream
 early, because it would wind up dropping any body contents that the
 client had already sent before it saw the ext_proc stream termination.
      bool request_drain = 12;
      Returns:
      The requestDrain.

    • hasOverrideMessageTimeout

      boolean hasOverrideMessageTimeout()
       When ext_proc server receives a request message, in case it needs more
 time to process the message, it sends back a ProcessingResponse message
 with a new timeout value. When the data plane receives this response
 message, it ignores other fields in the response, just stop the original
 timer, which has the timeout value specified in
 :ref:`message_timeout
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.message_timeout>`
 and start a new timer with this ``override_message_timeout`` value and keep the
 data plane ext_proc filter state machine intact.
 Has to be >= 1ms and <=
 :ref:`max_message_timeout <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.max_message_timeout>`
 Such message can be sent at most once in a particular data plane ext_proc filter processing state.
 To enable this API, one has to set ``max_message_timeout`` to a number >= 1ms.
      .google.protobuf.Duration override_message_timeout = 10;
      Returns:
      Whether the overrideMessageTimeout field is set.

    • getOverrideMessageTimeout

      com.google.protobuf.Duration getOverrideMessageTimeout()
       When ext_proc server receives a request message, in case it needs more
 time to process the message, it sends back a ProcessingResponse message
 with a new timeout value. When the data plane receives this response
 message, it ignores other fields in the response, just stop the original
 timer, which has the timeout value specified in
 :ref:`message_timeout
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.message_timeout>`
 and start a new timer with this ``override_message_timeout`` value and keep the
 data plane ext_proc filter state machine intact.
 Has to be >= 1ms and <=
 :ref:`max_message_timeout <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.max_message_timeout>`
 Such message can be sent at most once in a particular data plane ext_proc filter processing state.
 To enable this API, one has to set ``max_message_timeout`` to a number >= 1ms.
      .google.protobuf.Duration override_message_timeout = 10;
      Returns:
      The overrideMessageTimeout.

    • getOverrideMessageTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getOverrideMessageTimeoutOrBuilder()
       When ext_proc server receives a request message, in case it needs more
 time to process the message, it sends back a ProcessingResponse message
 with a new timeout value. When the data plane receives this response
 message, it ignores other fields in the response, just stop the original
 timer, which has the timeout value specified in
 :ref:`message_timeout
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.message_timeout>`
 and start a new timer with this ``override_message_timeout`` value and keep the
 data plane ext_proc filter state machine intact.
 Has to be >= 1ms and <=
 :ref:`max_message_timeout <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.max_message_timeout>`
 Such message can be sent at most once in a particular data plane ext_proc filter processing state.
 To enable this API, one has to set ``max_message_timeout`` to a number >= 1ms.
      .google.protobuf.Duration override_message_timeout = 10;

    • getResponseCase

      ProcessingResponse.ResponseCase getResponseCase()