io.envoyproxy.envoy.service.ext_proc.v3.ProcessingResponseOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/service/ext_proc/v3/external_processor.proto
// Protobuf Java Version: 3.25.1
package io.envoyproxy.envoy.service.ext_proc.v3;
public interface ProcessingResponseOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.service.ext_proc.v3.ProcessingResponse)
com.google.protobuf.MessageOrBuilder {
/**
*
* 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;
* @return Whether the requestHeaders field is set.
*/
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;
* @return The requestHeaders.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HeadersResponseOrBuilder getRequestHeadersOrBuilder();
/**
*
* 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;
* @return Whether the responseHeaders field is set.
*/
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;
* @return The responseHeaders.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HeadersResponseOrBuilder getResponseHeadersOrBuilder();
/**
*
* 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;
* @return Whether the requestBody field is set.
*/
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;
* @return The requestBody.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.BodyResponseOrBuilder getRequestBodyOrBuilder();
/**
*
* 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;
* @return Whether the responseBody field is set.
*/
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;
* @return The responseBody.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.BodyResponseOrBuilder getResponseBodyOrBuilder();
/**
*
* 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;
* @return Whether the requestTrailers field is set.
*/
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;
* @return The requestTrailers.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.TrailersResponseOrBuilder getRequestTrailersOrBuilder();
/**
*
* 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;
* @return Whether the responseTrailers field is set.
*/
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;
* @return The responseTrailers.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.TrailersResponseOrBuilder getResponseTrailersOrBuilder();
/**
*
* 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;
* @return Whether the immediateResponse field is set.
*/
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;
* @return The immediateResponse.
*/
io.envoyproxy.envoy.service.ext_proc.v3.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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.ImmediateResponseOrBuilder getImmediateResponseOrBuilder();
/**
*
* 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;
* @return Whether the dynamicMetadata field is set.
*/
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;
* @return The dynamicMetadata.
*/
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;
*/
com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder();
/**
*
* 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;
* @return Whether the modeOverride field is set.
*/
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;
* @return The modeOverride.
*/
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.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;
*/
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.ProcessingModeOrBuilder getModeOverrideOrBuilder();
/**
*
* 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;
* @return Whether the overrideMessageTimeout field is set.
*/
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;
* @return The overrideMessageTimeout.
*/
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;
*/
com.google.protobuf.DurationOrBuilder getOverrideMessageTimeoutOrBuilder();
io.envoyproxy.envoy.service.ext_proc.v3.ProcessingResponse.ResponseCase getResponseCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy