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

Class StreamedBodyResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.ext_proc.v3.StreamedBodyResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StreamedBodyResponseOrBuilder, Serializable
public final class StreamedBodyResponse extends com.google.protobuf.GeneratedMessageV3 implements StreamedBodyResponseOrBuilder
 The body response message corresponding to ``FULL_DUPLEX_STREAMED`` or ``GRPC`` body modes.
Protobuf type envoy.service.ext_proc.v3.StreamedBodyResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StreamedBodyResponse.Builder
    The body response message corresponding to ``FULL_DUPLEX_STREAMED`` or ``GRPC`` body modes.

    Nested 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BODY_FIELD_NUMBER
     
    static final int
    END_OF_STREAM_FIELD_NUMBER
     
    static final int
    END_OF_STREAM_WITHOUT_MESSAGE_FIELD_NUMBER
     
    static final int
    GRPC_MESSAGE_COMPRESSED_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static StreamedBodyResponse
    getDefaultInstance()
     
    StreamedBodyResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<StreamedBodyResponse>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StreamedBodyResponse.Builder
    newBuilder()
     
    static StreamedBodyResponse.Builder
    newBuilder(StreamedBodyResponse prototype)
     
    StreamedBodyResponse.Builder
    newBuilderForType()
     
    protected StreamedBodyResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static StreamedBodyResponse
    parseDelimitedFrom(InputStream input)
     
    static StreamedBodyResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamedBodyResponse
    parseFrom(byte[] data)
     
    static StreamedBodyResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamedBodyResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static StreamedBodyResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamedBodyResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StreamedBodyResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamedBodyResponse
    parseFrom(InputStream input)
     
    static StreamedBodyResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamedBodyResponse
    parseFrom(ByteBuffer data)
     
    static StreamedBodyResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StreamedBodyResponse>
    parser()
     
    StreamedBodyResponse.Builder
    toBuilder()
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • BODY_FIELD_NUMBER

      public static final int BODY_FIELD_NUMBER
      See Also:

    • END_OF_STREAM_FIELD_NUMBER

      public static final int END_OF_STREAM_FIELD_NUMBER
      See Also:

    • END_OF_STREAM_WITHOUT_MESSAGE_FIELD_NUMBER

      public static final int END_OF_STREAM_WITHOUT_MESSAGE_FIELD_NUMBER
      See Also:

    • GRPC_MESSAGE_COMPRESSED_FIELD_NUMBER

      public static final int GRPC_MESSAGE_COMPRESSED_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getBody

      public 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;
      Specified by:
      getBody in interface StreamedBodyResponseOrBuilder
      Returns:
      The body.

    • getEndOfStream

      public 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;
      Specified by:
      getEndOfStream in interface StreamedBodyResponseOrBuilder
      Returns:
      The endOfStream.

    • getEndOfStreamWithoutMessage

      public 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;
      Specified by:
      getEndOfStreamWithoutMessage in interface StreamedBodyResponseOrBuilder
      Returns:
      The endOfStreamWithoutMessage.

    • getGrpcMessageCompressed

      public 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;
      Specified by:
      getGrpcMessageCompressed in interface StreamedBodyResponseOrBuilder
      Returns:
      The grpcMessageCompressed.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StreamedBodyResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamedBodyResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamedBodyResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamedBodyResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamedBodyResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamedBodyResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamedBodyResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StreamedBodyResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StreamedBodyResponse.Builder newBuilder()

    • newBuilder

      public static StreamedBodyResponse.Builder newBuilder(StreamedBodyResponse prototype)

    • toBuilder

      public StreamedBodyResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StreamedBodyResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static StreamedBodyResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StreamedBodyResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<StreamedBodyResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public StreamedBodyResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder