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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Struct getDynamicMetadata()
      [#not-implemented-hide:] Optional metadata that will be emitted as dynamic metadata to be consumed by the next filter.
      com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
      [#not-implemented-hide:] Optional metadata that will be emitted as dynamic metadata to be consumed by the next filter.
      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.
      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.
      boolean hasDynamicMetadata()
      [#not-implemented-hide:] Optional metadata that will be emitted as dynamic metadata to be consumed by the next filter.
      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.

      • 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 Detail

      • 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;

      • hasDynamicMetadata

        boolean hasDynamicMetadata()
         [#not-implemented-hide:]
 Optional metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata will be placed in the namespace ``envoy.filters.http.ext_proc``.
        .google.protobuf.Struct dynamic_metadata = 8;
        Returns:
        Whether the dynamicMetadata field is set.

      • getDynamicMetadata

        com.google.protobuf.Struct getDynamicMetadata()
         [#not-implemented-hide:]
 Optional metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata will be placed in the namespace ``envoy.filters.http.ext_proc``.
        .google.protobuf.Struct dynamic_metadata = 8;
        Returns:
        The dynamicMetadata.

      • getDynamicMetadataOrBuilder

        com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
         [#not-implemented-hide:]
 Optional metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata will be placed in the namespace ``envoy.filters.http.ext_proc``.
        .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 Envoy.
 It is also ignored by Envoy 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.
        .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 Envoy.
 It is also ignored by Envoy 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.
        .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 Envoy.
 It is also ignored by Envoy 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.
        .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode mode_override = 9;

      • 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 Envoy 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
 Envoy 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 Envoy 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 Envoy 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
 Envoy 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 Envoy 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 Envoy 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
 Envoy 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 Envoy 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;