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

Class ProcessingRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProcessingRequestOrBuilder, Serializable
    public final class ProcessingRequest
extends com.google.protobuf.GeneratedMessageV3
implements ProcessingRequestOrBuilder
     This represents the different types of messages that Envoy can send
 to an external processing server.
 [#next-free-field: 8]
    Protobuf type envoy.service.ext_proc.v3.ProcessingRequest
    See Also:
    Serialized Form

    • Field Detail

      • ASYNC_MODE_FIELD_NUMBER

        public static final int ASYNC_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • 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

    • 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

      • getAsyncMode

        public boolean getAsyncMode()
         Specify whether the filter that sent this request is running in synchronous
 or asynchronous mode. The choice of synchronous or asynchronous mode
 can be set in the filter configuration, and defaults to false.
 * A value of ``false`` indicates that the server must respond
   to this message by either sending back a matching ProcessingResponse message,
   or by closing the stream.
 * A value of ``true`` indicates that the server must not respond to this
   message, although it may still close the stream to indicate that no more messages
   are needed.
        bool async_mode = 1;
        Specified by:
        getAsyncMode in interface ProcessingRequestOrBuilder
        Returns:
        The asyncMode.

      • hasRequestHeaders

        public boolean hasRequestHeaders()
         Information about the HTTP request headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders request_headers = 2;
        Specified by:
        hasRequestHeaders in interface ProcessingRequestOrBuilder
        Returns:
        Whether the requestHeaders field is set.

      • getRequestHeaders

        public HttpHeaders getRequestHeaders()
         Information about the HTTP request headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders request_headers = 2;
        Specified by:
        getRequestHeaders in interface ProcessingRequestOrBuilder
        Returns:
        The requestHeaders.

      • getRequestHeadersOrBuilder

        public HttpHeadersOrBuilder getRequestHeadersOrBuilder()
         Information about the HTTP request headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders request_headers = 2;
        Specified by:
        getRequestHeadersOrBuilder in interface ProcessingRequestOrBuilder

      • hasResponseHeaders

        public boolean hasResponseHeaders()
         Information about the HTTP response headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
        Specified by:
        hasResponseHeaders in interface ProcessingRequestOrBuilder
        Returns:
        Whether the responseHeaders field is set.

      • getResponseHeaders

        public HttpHeaders getResponseHeaders()
         Information about the HTTP response headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
        Specified by:
        getResponseHeaders in interface ProcessingRequestOrBuilder
        Returns:
        The responseHeaders.

      • getResponseHeadersOrBuilder

        public HttpHeadersOrBuilder getResponseHeadersOrBuilder()
         Information about the HTTP response headers, as well as peer info and additional
 properties. Unless ``async_mode`` is ``true``, the server must send back a
 HeaderResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
        Specified by:
        getResponseHeadersOrBuilder in interface ProcessingRequestOrBuilder

      • hasRequestBody

        public boolean hasRequestBody()
         A chunk of the HTTP request body. Unless ``async_mode`` is true, the server must send back
 a BodyResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpBody request_body = 4;
        Specified by:
        hasRequestBody in interface ProcessingRequestOrBuilder
        Returns:
        Whether the requestBody field is set.

      • getRequestBody

        public HttpBody getRequestBody()
         A chunk of the HTTP request body. Unless ``async_mode`` is true, the server must send back
 a BodyResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpBody request_body = 4;
        Specified by:
        getRequestBody in interface ProcessingRequestOrBuilder
        Returns:
        The requestBody.

      • getRequestBodyOrBuilder

        public HttpBodyOrBuilder getRequestBodyOrBuilder()
         A chunk of the HTTP request body. Unless ``async_mode`` is true, the server must send back
 a BodyResponse message, an ImmediateResponse message, or close the stream.
        .envoy.service.ext_proc.v3.HttpBody request_body = 4;
        Specified by:
        getRequestBodyOrBuilder in interface ProcessingRequestOrBuilder

      • hasResponseBody

        public boolean hasResponseBody()
         A chunk of the HTTP request body. Unless ``async_mode`` is ``true``, the server must send back
 a BodyResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpBody response_body = 5;
        Specified by:
        hasResponseBody in interface ProcessingRequestOrBuilder
        Returns:
        Whether the responseBody field is set.

      • getResponseBody

        public HttpBody getResponseBody()
         A chunk of the HTTP request body. Unless ``async_mode`` is ``true``, the server must send back
 a BodyResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpBody response_body = 5;
        Specified by:
        getResponseBody in interface ProcessingRequestOrBuilder
        Returns:
        The responseBody.

      • getResponseBodyOrBuilder

        public HttpBodyOrBuilder getResponseBodyOrBuilder()
         A chunk of the HTTP request body. Unless ``async_mode`` is ``true``, the server must send back
 a BodyResponse message or close the stream.
        .envoy.service.ext_proc.v3.HttpBody response_body = 5;
        Specified by:
        getResponseBodyOrBuilder in interface ProcessingRequestOrBuilder

      • hasRequestTrailers

        public boolean hasRequestTrailers()
         The HTTP trailers for the request path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
        Specified by:
        hasRequestTrailers in interface ProcessingRequestOrBuilder
        Returns:
        Whether the requestTrailers field is set.

      • getRequestTrailers

        public HttpTrailers getRequestTrailers()
         The HTTP trailers for the request path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
        Specified by:
        getRequestTrailers in interface ProcessingRequestOrBuilder
        Returns:
        The requestTrailers.

      • getRequestTrailersOrBuilder

        public HttpTrailersOrBuilder getRequestTrailersOrBuilder()
         The HTTP trailers for the request path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
        Specified by:
        getRequestTrailersOrBuilder in interface ProcessingRequestOrBuilder

      • hasResponseTrailers

        public boolean hasResponseTrailers()
         The HTTP trailers for the response path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
        Specified by:
        hasResponseTrailers in interface ProcessingRequestOrBuilder
        Returns:
        Whether the responseTrailers field is set.

      • getResponseTrailers

        public HttpTrailers getResponseTrailers()
         The HTTP trailers for the response path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
        Specified by:
        getResponseTrailers in interface ProcessingRequestOrBuilder
        Returns:
        The responseTrailers.

      • getResponseTrailersOrBuilder

        public HttpTrailersOrBuilder getResponseTrailersOrBuilder()
         The HTTP trailers for the response path. Unless ``async_mode`` is ``true``, the server
 must send back a TrailerResponse message or close the stream.
 This message is only sent if the trailers processing mode is set to ``SEND``.
 If there are no trailers on the original downstream request, then this message
 will only be sent (with empty trailers waiting to be populated) if the
 processing mode is set before the request headers are sent, such as
 in the filter configuration.
        .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
        Specified by:
        getResponseTrailersOrBuilder in interface ProcessingRequestOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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