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

Interface StreamedBodyResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getBody()
    In ``FULL_DUPLEX_STREAMED`` body send mode, contains the body response chunk that will be passed to the upstream/downstream by the data plane.
    boolean
    getEndOfStream()
    The server sets this flag to true if it has received a body request with :ref:`end_of_stream <envoy_v3_api_field_service.ext_proc.v3.HttpBody.end_of_stream>` set to true, and this is the last chunk of body responses.
    boolean
    getEndOfStreamWithoutMessage()
    This field is used in ``GRPC`` body send mode when ``end_of_stream`` is true and ``body`` is empty.
    boolean
    getGrpcMessageCompressed()
    This field is used in ``GRPC`` body send mode to indicate whether the message is compressed.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getBody

      com.google.protobuf.ByteString getBody()
       In ``FULL_DUPLEX_STREAMED`` body send mode, contains the body response chunk that will be
 passed to the upstream/downstream by the data plane. In ``GRPC`` body send mode, contains
 a serialized gRPC message to be passed to the upstream/downstream by the data plane.
      bytes body = 1;
      Returns:
      The body.

    • getEndOfStream

      boolean getEndOfStream()
       The server sets this flag to true if it has received a body request with
 :ref:`end_of_stream <envoy_v3_api_field_service.ext_proc.v3.HttpBody.end_of_stream>` set to true,
 and this is the last chunk of body responses.
 Note that in ``GRPC`` body send mode, this allows the ext_proc
 server to tell the data plane to send a half close after a client
 message, which will result in discarding any other messages sent by
 the client application.
      bool end_of_stream = 2;
      Returns:
      The endOfStream.

    • getEndOfStreamWithoutMessage

      boolean getEndOfStreamWithoutMessage()
       This field is used in ``GRPC`` body send mode when ``end_of_stream`` is
 true and ``body`` is empty. Those values would normally indicate an
 empty message on the stream with the end-of-stream bit set.
 However, if the half-close happens after the last message on the
 stream was already sent, then this field will be true to indicate an
 end-of-stream with *no* message (as opposed to an empty message).
      bool end_of_stream_without_message = 3;
      Returns:
      The endOfStreamWithoutMessage.

    • getGrpcMessageCompressed

      boolean getGrpcMessageCompressed()
       This field is used in ``GRPC`` body send mode to indicate whether
 the message is compressed. This will never be set to true by gRPC
 but may be set to true by a proxy like Envoy.
      bool grpc_message_compressed = 4;
      Returns:
      The grpcMessageCompressed.