io.envoyproxy.envoy.service.ext_proc.v3.ProcessingRequestOrBuilder 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 ProcessingRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.service.ext_proc.v3.ProcessingRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
* Information about the HTTP request headers, as well as peer info and additional
* properties. Unless ``observability_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;
* @return Whether the requestHeaders field is set.
*/
boolean hasRequestHeaders();
/**
*
* Information about the HTTP request headers, as well as peer info and additional
* properties. Unless ``observability_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;
* @return The requestHeaders.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpHeaders getRequestHeaders();
/**
*
* Information about the HTTP request headers, as well as peer info and additional
* properties. Unless ``observability_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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpHeadersOrBuilder getRequestHeadersOrBuilder();
/**
*
* Information about the HTTP response headers, as well as peer info and additional
* properties. Unless ``observability_mode`` is ``true``, the server must send back a
* HeaderResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
* @return Whether the responseHeaders field is set.
*/
boolean hasResponseHeaders();
/**
*
* Information about the HTTP response headers, as well as peer info and additional
* properties. Unless ``observability_mode`` is ``true``, the server must send back a
* HeaderResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
* @return The responseHeaders.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpHeaders getResponseHeaders();
/**
*
* Information about the HTTP response headers, as well as peer info and additional
* properties. Unless ``observability_mode`` is ``true``, the server must send back a
* HeaderResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpHeaders response_headers = 3;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpHeadersOrBuilder getResponseHeadersOrBuilder();
/**
*
* A chunk of the HTTP request body. Unless ``observability_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;
* @return Whether the requestBody field is set.
*/
boolean hasRequestBody();
/**
*
* A chunk of the HTTP request body. Unless ``observability_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;
* @return The requestBody.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpBody getRequestBody();
/**
*
* A chunk of the HTTP request body. Unless ``observability_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;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpBodyOrBuilder getRequestBodyOrBuilder();
/**
*
* A chunk of the HTTP response body. Unless ``observability_mode`` is ``true``, the server must send back
* a BodyResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpBody response_body = 5;
* @return Whether the responseBody field is set.
*/
boolean hasResponseBody();
/**
*
* A chunk of the HTTP response body. Unless ``observability_mode`` is ``true``, the server must send back
* a BodyResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpBody response_body = 5;
* @return The responseBody.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpBody getResponseBody();
/**
*
* A chunk of the HTTP response body. Unless ``observability_mode`` is ``true``, the server must send back
* a BodyResponse message or close the stream.
*
*
* .envoy.service.ext_proc.v3.HttpBody response_body = 5;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpBodyOrBuilder getResponseBodyOrBuilder();
/**
*
* The HTTP trailers for the request path. Unless ``observability_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`` and
* the original downstream request has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
* @return Whether the requestTrailers field is set.
*/
boolean hasRequestTrailers();
/**
*
* The HTTP trailers for the request path. Unless ``observability_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`` and
* the original downstream request has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
* @return The requestTrailers.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpTrailers getRequestTrailers();
/**
*
* The HTTP trailers for the request path. Unless ``observability_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`` and
* the original downstream request has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers request_trailers = 6;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpTrailersOrBuilder getRequestTrailersOrBuilder();
/**
*
* The HTTP trailers for the response path. Unless ``observability_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`` and
* the original upstream response has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
* @return Whether the responseTrailers field is set.
*/
boolean hasResponseTrailers();
/**
*
* The HTTP trailers for the response path. Unless ``observability_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`` and
* the original upstream response has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
* @return The responseTrailers.
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpTrailers getResponseTrailers();
/**
*
* The HTTP trailers for the response path. Unless ``observability_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`` and
* the original upstream response has trailers.
*
*
* .envoy.service.ext_proc.v3.HttpTrailers response_trailers = 7;
*/
io.envoyproxy.envoy.service.ext_proc.v3.HttpTrailersOrBuilder getResponseTrailersOrBuilder();
/**
*
* Dynamic metadata associated with the request.
*
*
* .envoy.config.core.v3.Metadata metadata_context = 8;
* @return Whether the metadataContext field is set.
*/
boolean hasMetadataContext();
/**
*
* Dynamic metadata associated with the request.
*
*
* .envoy.config.core.v3.Metadata metadata_context = 8;
* @return The metadataContext.
*/
io.envoyproxy.envoy.config.core.v3.Metadata getMetadataContext();
/**
*
* Dynamic metadata associated with the request.
*
*
* .envoy.config.core.v3.Metadata metadata_context = 8;
*/
io.envoyproxy.envoy.config.core.v3.MetadataOrBuilder getMetadataContextOrBuilder();
/**
*
* The values of properties selected by the ``request_attributes``
* or ``response_attributes`` list in the configuration. Each entry
* in the list is populated from the standard
* :ref:`attributes <arch_overview_attributes>` supported across Envoy.
*
*
* map<string, .google.protobuf.Struct> attributes = 9;
*/
int getAttributesCount();
/**
*
* The values of properties selected by the ``request_attributes``
* or ``response_attributes`` list in the configuration. Each entry
* in the list is populated from the standard
* :ref:`attributes <arch_overview_attributes>` supported across Envoy.
*
*
* map<string, .google.protobuf.Struct> attributes = 9;
*/
boolean containsAttributes(
java.lang.String key);
/**
* Use {@link #getAttributesMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getAttributes();
/**
*
* The values of properties selected by the ``request_attributes``
* or ``response_attributes`` list in the configuration. Each entry
* in the list is populated from the standard
* :ref:`attributes <arch_overview_attributes>` supported across Envoy.
*
*
* map<string, .google.protobuf.Struct> attributes = 9;
*/
java.util.Map
getAttributesMap();
/**
*
* The values of properties selected by the ``request_attributes``
* or ``response_attributes`` list in the configuration. Each entry
* in the list is populated from the standard
* :ref:`attributes <arch_overview_attributes>` supported across Envoy.
*
*
* map<string, .google.protobuf.Struct> attributes = 9;
*/
/* nullable */
com.google.protobuf.Struct getAttributesOrDefault(
java.lang.String key,
/* nullable */
com.google.protobuf.Struct defaultValue);
/**
*
* The values of properties selected by the ``request_attributes``
* or ``response_attributes`` list in the configuration. Each entry
* in the list is populated from the standard
* :ref:`attributes <arch_overview_attributes>` supported across Envoy.
*
*
* map<string, .google.protobuf.Struct> attributes = 9;
*/
com.google.protobuf.Struct getAttributesOrThrow(
java.lang.String key);
/**
*
* Specify whether the filter that sent this request is running in :ref:`observability_mode
* <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.observability_mode>`
* 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 should not respond to this message, as any
* responses will be ignored. However, it may still close the stream to indicate that no more messages
* are needed.
*
*
* bool observability_mode = 10;
* @return The observabilityMode.
*/
boolean getObservabilityMode();
io.envoyproxy.envoy.service.ext_proc.v3.ProcessingRequest.RequestCase getRequestCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy