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

Class CommonResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.ext_proc.v3.CommonResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonResponseOrBuilder, Serializable
public final class CommonResponse extends com.google.protobuf.GeneratedMessageV3 implements CommonResponseOrBuilder
 This message contains common fields between header and body responses.
 [#next-free-field: 6]
Protobuf type envoy.service.ext_proc.v3.CommonResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CommonResponse.Builder
    This message contains common fields between header and body responses.
    static enum 
    CommonResponse.ResponseStatus
    The status of the response.

    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_MUTATION_FIELD_NUMBER
     
    static final int
    CLEAR_ROUTE_CACHE_FIELD_NUMBER
     
    static final int
    HEADER_MUTATION_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    TRAILERS_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)
     
    BodyMutation
    getBodyMutation()
    Replace the body of the last message sent to the remote server on this stream.
    BodyMutationOrBuilder
    getBodyMutationOrBuilder()
    Replace the body of the last message sent to the remote server on this stream.
    boolean
    getClearRouteCache()
    Clear the route cache for the current client request.
    static CommonResponse
    getDefaultInstance()
     
    CommonResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    HeaderMutation
    getHeaderMutation()
    Instructions on how to manipulate the headers.
    HeaderMutationOrBuilder
    getHeaderMutationOrBuilder()
    Instructions on how to manipulate the headers.
    com.google.protobuf.Parser<CommonResponse>
    getParserForType()
     
    int
    getSerializedSize()
     
    CommonResponse.ResponseStatus
    getStatus()
    If set, provide additional direction on how the data plane should handle the rest of the HTTP filter chain.
    int
    getStatusValue()
    If set, provide additional direction on how the data plane should handle the rest of the HTTP filter chain.
    HeaderMap
    getTrailers()
    [#not-implemented-hide:] Add new trailers to the message.
    HeaderMapOrBuilder
    getTrailersOrBuilder()
    [#not-implemented-hide:] Add new trailers to the message.
    boolean
    hasBodyMutation()
    Replace the body of the last message sent to the remote server on this stream.
    int
    hashCode()
     
    boolean
    hasHeaderMutation()
    Instructions on how to manipulate the headers.
    boolean
    hasTrailers()
    [#not-implemented-hide:] Add new trailers to the message.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CommonResponse.Builder
    newBuilder()
     
    static CommonResponse.Builder
    newBuilder(CommonResponse prototype)
     
    CommonResponse.Builder
    newBuilderForType()
     
    protected CommonResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CommonResponse
    parseDelimitedFrom(InputStream input)
     
    static CommonResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CommonResponse
    parseFrom(byte[] data)
     
    static CommonResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CommonResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static CommonResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CommonResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CommonResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CommonResponse
    parseFrom(InputStream input)
     
    static CommonResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CommonResponse
    parseFrom(ByteBuffer data)
     
    static CommonResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CommonResponse>
    parser()
     
    CommonResponse.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

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • HEADER_MUTATION_FIELD_NUMBER

      public static final int HEADER_MUTATION_FIELD_NUMBER
      See Also:

    • BODY_MUTATION_FIELD_NUMBER

      public static final int BODY_MUTATION_FIELD_NUMBER
      See Also:

    • TRAILERS_FIELD_NUMBER

      public static final int TRAILERS_FIELD_NUMBER
      See Also:

    • CLEAR_ROUTE_CACHE_FIELD_NUMBER

      public static final int CLEAR_ROUTE_CACHE_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

    • getStatusValue

      public int getStatusValue()
       If set, provide additional direction on how the data plane should
 handle the rest of the HTTP filter chain.
      .envoy.service.ext_proc.v3.CommonResponse.ResponseStatus status = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatusValue in interface CommonResponseOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      public CommonResponse.ResponseStatus getStatus()
       If set, provide additional direction on how the data plane should
 handle the rest of the HTTP filter chain.
      .envoy.service.ext_proc.v3.CommonResponse.ResponseStatus status = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatus in interface CommonResponseOrBuilder
      Returns:
      The status.

    • hasHeaderMutation

      public boolean hasHeaderMutation()
       Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
      .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;
      Specified by:
      hasHeaderMutation in interface CommonResponseOrBuilder
      Returns:
      Whether the headerMutation field is set.

    • getHeaderMutation

      public HeaderMutation getHeaderMutation()
       Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
      .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;
      Specified by:
      getHeaderMutation in interface CommonResponseOrBuilder
      Returns:
      The headerMutation.

    • getHeaderMutationOrBuilder

      public HeaderMutationOrBuilder getHeaderMutationOrBuilder()
       Instructions on how to manipulate the headers. When responding to an
 HttpBody request, header mutations will only take effect if
 the current processing mode for the body is BUFFERED.
      .envoy.service.ext_proc.v3.HeaderMutation header_mutation = 2;
      Specified by:
      getHeaderMutationOrBuilder in interface CommonResponseOrBuilder

    • hasBodyMutation

      public boolean hasBodyMutation()
       Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
      .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;
      Specified by:
      hasBodyMutation in interface CommonResponseOrBuilder
      Returns:
      Whether the bodyMutation field is set.

    • getBodyMutation

      public BodyMutation getBodyMutation()
       Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
      .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;
      Specified by:
      getBodyMutation in interface CommonResponseOrBuilder
      Returns:
      The bodyMutation.

    • getBodyMutationOrBuilder

      public BodyMutationOrBuilder getBodyMutationOrBuilder()
       Replace the body of the last message sent to the remote server on this
 stream. If responding to an HttpBody request, simply replace or clear
 the body chunk that was sent with that request. Body mutations may take
 effect in response either to ``header`` or ``body`` messages. When it is
 in response to ``header`` messages, it only take effect if the
 :ref:`status <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.status>`
 is set to CONTINUE_AND_REPLACE.
      .envoy.service.ext_proc.v3.BodyMutation body_mutation = 3;
      Specified by:
      getBodyMutationOrBuilder in interface CommonResponseOrBuilder

    • hasTrailers

      public boolean hasTrailers()
       [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
      .envoy.config.core.v3.HeaderMap trailers = 4;
      Specified by:
      hasTrailers in interface CommonResponseOrBuilder
      Returns:
      Whether the trailers field is set.

    • getTrailers

      public HeaderMap getTrailers()
       [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
      .envoy.config.core.v3.HeaderMap trailers = 4;
      Specified by:
      getTrailers in interface CommonResponseOrBuilder
      Returns:
      The trailers.

    • getTrailersOrBuilder

      public HeaderMapOrBuilder getTrailersOrBuilder()
       [#not-implemented-hide:]
 Add new trailers to the message. This may be used when responding to either a
 HttpHeaders or HttpBody message, but only if this message is returned
 along with the CONTINUE_AND_REPLACE status.
 The header value is encoded in the
 :ref:`raw_value <envoy_v3_api_field_config.core.v3.HeaderValue.raw_value>` field.
      .envoy.config.core.v3.HeaderMap trailers = 4;
      Specified by:
      getTrailersOrBuilder in interface CommonResponseOrBuilder

    • getClearRouteCache

      public boolean getClearRouteCache()
       Clear the route cache for the current client request. This is necessary
 if the remote server modified headers that are used to calculate the route.
 This field is ignored in the response direction. This field is also ignored
 if the data plane ext_proc filter is in the upstream filter chain.
      bool clear_route_cache = 5;
      Specified by:
      getClearRouteCache in interface CommonResponseOrBuilder
      Returns:
      The clearRouteCache.

    • 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 CommonResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CommonResponse.Builder newBuilder()

    • newBuilder

      public static CommonResponse.Builder newBuilder(CommonResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CommonResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CommonResponse> 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 CommonResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder