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

Interface ProcessingRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ProcessingRequest, ProcessingRequest.Builder
public interface ProcessingRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasRequestHeaders

      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;
      Returns:
      Whether the requestHeaders field is set.

    • getRequestHeaders

      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;
      Returns:
      The requestHeaders.

    • getRequestHeadersOrBuilder

      HttpHeadersOrBuilder getRequestHeadersOrBuilder()
       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;

    • hasResponseHeaders

      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;
      Returns:
      Whether the responseHeaders field is set.

    • getResponseHeaders

      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;
      Returns:
      The responseHeaders.

    • getResponseHeadersOrBuilder

      HttpHeadersOrBuilder getResponseHeadersOrBuilder()
       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;

    • hasRequestBody

      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;
      Returns:
      Whether the requestBody field is set.

    • getRequestBody

      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;
      Returns:
      The requestBody.

    • getRequestBodyOrBuilder

      HttpBodyOrBuilder getRequestBodyOrBuilder()
       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;

    • hasResponseBody

      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;
      Returns:
      Whether the responseBody field is set.

    • getResponseBody

      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;
      Returns:
      The responseBody.

    • getResponseBodyOrBuilder

      HttpBodyOrBuilder getResponseBodyOrBuilder()
       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;

    • hasRequestTrailers

      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;
      Returns:
      Whether the requestTrailers field is set.

    • getRequestTrailers

      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;
      Returns:
      The requestTrailers.

    • getRequestTrailersOrBuilder

      HttpTrailersOrBuilder getRequestTrailersOrBuilder()
       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;

    • hasResponseTrailers

      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;
      Returns:
      Whether the responseTrailers field is set.

    • getResponseTrailers

      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;
      Returns:
      The responseTrailers.

    • getResponseTrailersOrBuilder

      HttpTrailersOrBuilder getResponseTrailersOrBuilder()
       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;

    • hasMetadataContext

      boolean hasMetadataContext()
       Dynamic metadata associated with the request.
      .envoy.config.core.v3.Metadata metadata_context = 8;
      Returns:
      Whether the metadataContext field is set.

    • getMetadataContext

      Metadata getMetadataContext()
       Dynamic metadata associated with the request.
      .envoy.config.core.v3.Metadata metadata_context = 8;
      Returns:
      The metadataContext.

    • getMetadataContextOrBuilder

      MetadataOrBuilder getMetadataContextOrBuilder()
       Dynamic metadata associated with the request.
      .envoy.config.core.v3.Metadata metadata_context = 8;

    • getAttributesCount

      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 in the data plane.
      map<string, .google.protobuf.Struct> attributes = 9;

    • containsAttributes

      boolean containsAttributes(String key)
       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 in the data plane.
      map<string, .google.protobuf.Struct> attributes = 9;

    • getAttributes

      @Deprecated Map<String,com.google.protobuf.Struct> getAttributes()
      Deprecated.
      Use getAttributesMap() instead.

    • getAttributesMap

      Map<String,com.google.protobuf.Struct> 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 in the data plane.
      map<string, .google.protobuf.Struct> attributes = 9;

    • getAttributesOrDefault

      com.google.protobuf.Struct getAttributesOrDefault(String key, 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 in the data plane.
      map<string, .google.protobuf.Struct> attributes = 9;

    • getAttributesOrThrow

      com.google.protobuf.Struct getAttributesOrThrow(String key)
       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 in the data plane.
      map<string, .google.protobuf.Struct> attributes = 9;

    • getObservabilityMode

      boolean getObservabilityMode()
       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;
      Returns:
      The observabilityMode.

    • hasProtocolConfig

      boolean hasProtocolConfig()
       Specify the filter protocol configurations to be sent to the server.
 ``protocol_config`` is only encoded in the first ``ProcessingRequest`` message from the client to the server.
      .envoy.service.ext_proc.v3.ProtocolConfiguration protocol_config = 11;
      Returns:
      Whether the protocolConfig field is set.

    • getProtocolConfig

      ProtocolConfiguration getProtocolConfig()
       Specify the filter protocol configurations to be sent to the server.
 ``protocol_config`` is only encoded in the first ``ProcessingRequest`` message from the client to the server.
      .envoy.service.ext_proc.v3.ProtocolConfiguration protocol_config = 11;
      Returns:
      The protocolConfig.

    • getProtocolConfigOrBuilder

      ProtocolConfigurationOrBuilder getProtocolConfigOrBuilder()
       Specify the filter protocol configurations to be sent to the server.
 ``protocol_config`` is only encoded in the first ``ProcessingRequest`` message from the client to the server.
      .envoy.service.ext_proc.v3.ProtocolConfiguration protocol_config = 11;

    • getRequestCase

      ProcessingRequest.RequestCase getRequestCase()