Class ProcessingResponse
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.ext_proc.v3.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
This represents the different types of messages the server may send back to the data plane when the ``observability_mode`` field in the received ProcessingRequest is set to false. * If the corresponding ``BodySendMode`` in the :ref:`processing_mode <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>` is not set to ``FULL_DUPLEX_STREAMED``, then for every received ProcessingRequest, the server must send back exactly one ProcessingResponse message. * If it is set to ``FULL_DUPLEX_STREAMED``, the server must follow the API defined for this mode to send the ProcessingResponse messages. [#next-free-field: 13]Protobuf type
envoy.service.ext_proc.v3.ProcessingResponse- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThis represents the different types of messages the server may send back to the data plane when the ``observability_mode`` field in the received ProcessingRequest is set to falsestatic enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic ProcessingResponsestatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.StructOptional metadata that will be emitted as dynamic metadata to be consumed by following filters.com.google.protobuf.StructOrBuilderOptional metadata that will be emitted as dynamic metadata to be consumed by following filters.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 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.Override how parts of the HTTP request and response are processed for the duration of this particular request/response only.Override how parts of the HTTP request and response are processed for the duration of this particular request/response only.com.google.protobuf.DurationWhen 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.DurationOrBuilderWhen 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.Parser<ProcessingResponse>The server must send back this message in response to a message with the ``request_body`` field set.The server must send back this message in response to a message with the ``request_body`` field set.boolean[#not-implemented-hide:] Used only in ``FULL_DUPLEX_STREAMED`` and ``GRPC`` body send modes.The server must send back this message in response to a message with the ``request_headers`` field set.The server must send back this message in response to a message with the ``request_headers`` field set.The server must send back this message in response to a message with the ``request_trailers`` field set.The server must send back this message in response to a message with the ``request_trailers`` field set.The server must send back this message in response to a message with the ``response_body`` field set.The server must send back this message in response to a message with the ``response_body`` field set.The server must send back this message in response to a message with the ``response_headers`` field set.The server must send back this message in response to a message with the ``response_headers`` field set.The server must send back this message in response to a message with the ``response_trailers`` field set.The server must send back this message in response to a message with the ``response_trailers`` field set.intThe server sends back this message to initiate or continue local response streaming.The server sends back this message to initiate or continue local response streaming.booleanOptional metadata that will be emitted as dynamic metadata to be consumed by following filters.inthashCode()booleanIf 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.booleanOverride how parts of the HTTP request and response are processed for the duration of this particular request/response only.booleanWhen 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.booleanThe server must send back this message in response to a message with the ``request_body`` field set.booleanThe server must send back this message in response to a message with the ``request_headers`` field set.booleanThe server must send back this message in response to a message with the ``request_trailers`` field set.booleanThe server must send back this message in response to a message with the ``response_body`` field set.booleanThe server must send back this message in response to a message with the ``response_headers`` field set.booleanThe server must send back this message in response to a message with the ``response_trailers`` field set.booleanThe server sends back this message to initiate or continue local response streaming.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic ProcessingResponse.Builderstatic ProcessingResponse.BuildernewBuilder(ProcessingResponse prototype) protected ProcessingResponse.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ProcessingResponseparseDelimitedFrom(InputStream input) static ProcessingResponseparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingResponseparseFrom(byte[] data) static ProcessingResponseparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingResponseparseFrom(com.google.protobuf.ByteString data) static ProcessingResponseparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingResponseparseFrom(com.google.protobuf.CodedInputStream input) static ProcessingResponseparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingResponseparseFrom(InputStream input) static ProcessingResponseparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingResponseparseFrom(ByteBuffer data) static ProcessingResponseparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ProcessingResponse>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
REQUEST_HEADERS_FIELD_NUMBER
public static final int REQUEST_HEADERS_FIELD_NUMBER- See Also:
-
RESPONSE_HEADERS_FIELD_NUMBER
public static final int RESPONSE_HEADERS_FIELD_NUMBER- See Also:
-
REQUEST_BODY_FIELD_NUMBER
public static final int REQUEST_BODY_FIELD_NUMBER- See Also:
-
RESPONSE_BODY_FIELD_NUMBER
public static final int RESPONSE_BODY_FIELD_NUMBER- See Also:
-
REQUEST_TRAILERS_FIELD_NUMBER
public static final int REQUEST_TRAILERS_FIELD_NUMBER- See Also:
-
RESPONSE_TRAILERS_FIELD_NUMBER
public static final int RESPONSE_TRAILERS_FIELD_NUMBER- See Also:
-
IMMEDIATE_RESPONSE_FIELD_NUMBER
public static final int IMMEDIATE_RESPONSE_FIELD_NUMBER- See Also:
-
STREAMED_IMMEDIATE_RESPONSE_FIELD_NUMBER
public static final int STREAMED_IMMEDIATE_RESPONSE_FIELD_NUMBER- See Also:
-
DYNAMIC_METADATA_FIELD_NUMBER
public static final int DYNAMIC_METADATA_FIELD_NUMBER- See Also:
-
MODE_OVERRIDE_FIELD_NUMBER
public static final int MODE_OVERRIDE_FIELD_NUMBER- See Also:
-
REQUEST_DRAIN_FIELD_NUMBER
public static final int REQUEST_DRAIN_FIELD_NUMBER- See Also:
-
OVERRIDE_MESSAGE_TIMEOUT_FIELD_NUMBER
public static final int OVERRIDE_MESSAGE_TIMEOUT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getResponseCase
- Specified by:
getResponseCasein interfaceProcessingResponseOrBuilder
-
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:
hasRequestHeadersin interfaceProcessingResponseOrBuilder- Returns:
- Whether the requestHeaders field is set.
-
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:
getRequestHeadersin interfaceProcessingResponseOrBuilder- Returns:
- The requestHeaders.
-
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;- Specified by:
getRequestHeadersOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasResponseHeadersin interfaceProcessingResponseOrBuilder- Returns:
- Whether the responseHeaders field is set.
-
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:
getResponseHeadersin interfaceProcessingResponseOrBuilder- Returns:
- The responseHeaders.
-
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;- Specified by:
getResponseHeadersOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasRequestBodyin interfaceProcessingResponseOrBuilder- Returns:
- Whether the requestBody field is set.
-
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:
getRequestBodyin interfaceProcessingResponseOrBuilder- Returns:
- The requestBody.
-
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;- Specified by:
getRequestBodyOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasResponseBodyin interfaceProcessingResponseOrBuilder- Returns:
- Whether the responseBody field is set.
-
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:
getResponseBodyin interfaceProcessingResponseOrBuilder- Returns:
- The responseBody.
-
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;- Specified by:
getResponseBodyOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasRequestTrailersin interfaceProcessingResponseOrBuilder- Returns:
- Whether the requestTrailers field is set.
-
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:
getRequestTrailersin interfaceProcessingResponseOrBuilder- Returns:
- The requestTrailers.
-
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;- Specified by:
getRequestTrailersOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasResponseTrailersin interfaceProcessingResponseOrBuilder- Returns:
- Whether the responseTrailers field is set.
-
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:
getResponseTrailersin interfaceProcessingResponseOrBuilder- Returns:
- The responseTrailers.
-
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;- Specified by:
getResponseTrailersOrBuilderin interfaceProcessingResponseOrBuilder
-
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:
hasImmediateResponsein interfaceProcessingResponseOrBuilder- Returns:
- Whether the immediateResponse field is set.
-
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:
getImmediateResponsein interfaceProcessingResponseOrBuilder- Returns:
- The immediateResponse.
-
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:
getImmediateResponseOrBuilderin interfaceProcessingResponseOrBuilder
-
hasStreamedImmediateResponse
public 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;- Specified by:
hasStreamedImmediateResponsein interfaceProcessingResponseOrBuilder- Returns:
- Whether the streamedImmediateResponse field is set.
-
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;- Specified by:
getStreamedImmediateResponsein interfaceProcessingResponseOrBuilder- Returns:
- The streamedImmediateResponse.
-
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;- Specified by:
getStreamedImmediateResponseOrBuilderin interfaceProcessingResponseOrBuilder
-
hasDynamicMetadata
public 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;- Specified by:
hasDynamicMetadatain interfaceProcessingResponseOrBuilder- Returns:
- Whether the dynamicMetadata field is set.
-
getDynamicMetadata
public 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;- Specified by:
getDynamicMetadatain interfaceProcessingResponseOrBuilder- Returns:
- The dynamicMetadata.
-
getDynamicMetadataOrBuilder
public 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;- Specified by:
getDynamicMetadataOrBuilderin interfaceProcessingResponseOrBuilder
-
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 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;- Specified by:
hasModeOverridein interfaceProcessingResponseOrBuilder- Returns:
- Whether the modeOverride field is set.
-
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;- Specified by:
getModeOverridein interfaceProcessingResponseOrBuilder- Returns:
- The modeOverride.
-
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;- Specified by:
getModeOverrideOrBuilderin interfaceProcessingResponseOrBuilder
-
getRequestDrain
public 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;- Specified by:
getRequestDrainin interfaceProcessingResponseOrBuilder- Returns:
- The requestDrain.
-
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 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;- Specified by:
hasOverrideMessageTimeoutin interfaceProcessingResponseOrBuilder- 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 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;- Specified by:
getOverrideMessageTimeoutin interfaceProcessingResponseOrBuilder- 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 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;- Specified by:
getOverrideMessageTimeoutOrBuilderin interfaceProcessingResponseOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static ProcessingResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ProcessingResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ProcessingResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ProcessingResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ProcessingResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-