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

Class ProcessingResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProcessingResponseOrBuilder, Serializable
    public final class ProcessingResponse
extends com.google.protobuf.GeneratedMessageV3
implements ProcessingResponseOrBuilder
     For every ProcessingRequest received by the server with the ``async_mode`` field
 set to false, the server must send back exactly one ProcessingResponse message.
 [#next-free-field: 11]
    Protobuf type envoy.service.ext_proc.v3.ProcessingResponse
    See Also:
    Serialized Form

    • Field Detail

      • REQUEST_HEADERS_FIELD_NUMBER

        public static final int REQUEST_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_HEADERS_FIELD_NUMBER

        public static final int RESPONSE_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_BODY_FIELD_NUMBER

        public static final int REQUEST_BODY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_BODY_FIELD_NUMBER

        public static final int RESPONSE_BODY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_TRAILERS_FIELD_NUMBER

        public static final int REQUEST_TRAILERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_TRAILERS_FIELD_NUMBER

        public static final int RESPONSE_TRAILERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IMMEDIATE_RESPONSE_FIELD_NUMBER

        public static final int IMMEDIATE_RESPONSE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DYNAMIC_METADATA_FIELD_NUMBER

        public static final int DYNAMIC_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODE_OVERRIDE_FIELD_NUMBER

        public static final int MODE_OVERRIDE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OVERRIDE_MESSAGE_TIMEOUT_FIELD_NUMBER

        public static final int OVERRIDE_MESSAGE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasRequestHeaders

        public 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;
        Specified by:
        hasRequestHeaders in interface ProcessingResponseOrBuilder
        Returns:
        Whether the requestHeaders field is set.

      • getRequestHeaders

        public 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;
        Specified by:
        getRequestHeaders in interface ProcessingResponseOrBuilder
        Returns:
        The requestHeaders.

      • hasResponseHeaders

        public 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;
        Specified by:
        hasResponseHeaders in interface ProcessingResponseOrBuilder
        Returns:
        Whether the responseHeaders field is set.

      • getResponseHeaders

        public 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;
        Specified by:
        getResponseHeaders in interface ProcessingResponseOrBuilder
        Returns:
        The responseHeaders.

      • hasRequestBody

        public 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;
        Specified by:
        hasRequestBody in interface ProcessingResponseOrBuilder
        Returns:
        Whether the requestBody field is set.

      • getRequestBody

        public 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;
        Specified by:
        getRequestBody in interface ProcessingResponseOrBuilder
        Returns:
        The requestBody.

      • hasResponseBody

        public 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;
        Specified by:
        hasResponseBody in interface ProcessingResponseOrBuilder
        Returns:
        Whether the responseBody field is set.

      • getResponseBody

        public 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;
        Specified by:
        getResponseBody in interface ProcessingResponseOrBuilder
        Returns:
        The responseBody.

      • hasRequestTrailers

        public 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;
        Specified by:
        hasRequestTrailers in interface ProcessingResponseOrBuilder
        Returns:
        Whether the requestTrailers field is set.

      • getRequestTrailers

        public 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;
        Specified by:
        getRequestTrailers in interface ProcessingResponseOrBuilder
        Returns:
        The requestTrailers.

      • hasResponseTrailers

        public 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;
        Specified by:
        hasResponseTrailers in interface ProcessingResponseOrBuilder
        Returns:
        Whether the responseTrailers field is set.

      • getResponseTrailers

        public 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;
        Specified by:
        getResponseTrailers in interface ProcessingResponseOrBuilder
        Returns:
        The responseTrailers.

      • hasImmediateResponse

        public 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;
        Specified by:
        hasImmediateResponse in interface ProcessingResponseOrBuilder
        Returns:
        Whether the immediateResponse field is set.

      • getImmediateResponse

        public 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;
        Specified by:
        getImmediateResponse in interface ProcessingResponseOrBuilder
        Returns:
        The immediateResponse.

      • getImmediateResponseOrBuilder

        public 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;
        Specified by:
        getImmediateResponseOrBuilder in interface ProcessingResponseOrBuilder

      • hasDynamicMetadata

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

      • getDynamicMetadata

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

      • getDynamicMetadataOrBuilder

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

      • hasModeOverride

        public 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;
        Specified by:
        hasModeOverride in interface ProcessingResponseOrBuilder
        Returns:
        Whether the modeOverride field is set.

      • getModeOverride

        public 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;
        Specified by:
        getModeOverride in interface ProcessingResponseOrBuilder
        Returns:
        The modeOverride.

      • getModeOverrideOrBuilder

        public 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;
        Specified by:
        getModeOverrideOrBuilder in interface ProcessingResponseOrBuilder

      • hasOverrideMessageTimeout

        public 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;
        Specified by:
        hasOverrideMessageTimeout in interface ProcessingResponseOrBuilder
        Returns:
        Whether the overrideMessageTimeout field is set.

      • getOverrideMessageTimeout

        public 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;
        Specified by:
        getOverrideMessageTimeout in interface ProcessingResponseOrBuilder
        Returns:
        The overrideMessageTimeout.

      • getOverrideMessageTimeoutOrBuilder

        public 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;
        Specified by:
        getOverrideMessageTimeoutOrBuilder in interface ProcessingResponseOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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