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

Class CommonResponse.Builder

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

  • Method Details

    • 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.Builder<CommonResponse.Builder>

    • clear

      public CommonResponse.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public CommonResponse.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • setField

      public CommonResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • clearField

      public CommonResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • clearOneof

      public CommonResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • setRepeatedField

      public CommonResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • addRepeatedField

      public CommonResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • mergeFrom

      public CommonResponse.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CommonResponse.Builder>

    • mergeFrom

      public CommonResponse.Builder mergeFrom(CommonResponse other)

    • isInitialized

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

    • mergeFrom

      public CommonResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CommonResponse.Builder>
      Throws:
      IOException

    • 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.

    • setStatusValue

      public CommonResponse.Builder setStatusValue(int value)
       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) = { ... }
      Parameters:
      value - The enum numeric value on the wire for status to set.
      Returns:
      This builder for chaining.

    • 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.

    • setStatus

      public CommonResponse.Builder setStatus(CommonResponse.ResponseStatus value)
       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) = { ... }
      Parameters:
      value - The status to set.
      Returns:
      This builder for chaining.

    • clearStatus

      public CommonResponse.Builder clearStatus()
       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) = { ... }
      Returns:
      This builder for chaining.

    • 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.

    • setHeaderMutation

      public CommonResponse.Builder setHeaderMutation(HeaderMutation value)
       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;

    • setHeaderMutation

      public CommonResponse.Builder setHeaderMutation(HeaderMutation.Builder builderForValue)
       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;

    • mergeHeaderMutation

      public CommonResponse.Builder mergeHeaderMutation(HeaderMutation value)
       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;

    • clearHeaderMutation

      public CommonResponse.Builder clearHeaderMutation()
       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;

    • getHeaderMutationBuilder

      public HeaderMutation.Builder getHeaderMutationBuilder()
       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;

    • 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.

    • setBodyMutation

      public CommonResponse.Builder setBodyMutation(BodyMutation value)
       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;

    • setBodyMutation

      public CommonResponse.Builder setBodyMutation(BodyMutation.Builder builderForValue)
       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;

    • mergeBodyMutation

      public CommonResponse.Builder mergeBodyMutation(BodyMutation value)
       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;

    • clearBodyMutation

      public CommonResponse.Builder clearBodyMutation()
       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;

    • getBodyMutationBuilder

      public BodyMutation.Builder getBodyMutationBuilder()
       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;

    • 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.

    • setTrailers

      public CommonResponse.Builder setTrailers(HeaderMap value)
       [#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;

    • setTrailers

      public CommonResponse.Builder setTrailers(HeaderMap.Builder builderForValue)
       [#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;

    • mergeTrailers

      public CommonResponse.Builder mergeTrailers(HeaderMap value)
       [#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;

    • clearTrailers

      public CommonResponse.Builder clearTrailers()
       [#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;

    • getTrailersBuilder

      public HeaderMap.Builder getTrailersBuilder()
       [#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;

    • 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.

    • setClearRouteCache

      public CommonResponse.Builder setClearRouteCache(boolean value)
       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;
      Parameters:
      value - The clearRouteCache to set.
      Returns:
      This builder for chaining.

    • clearClearRouteCache

      public CommonResponse.Builder clearClearRouteCache()
       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;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final CommonResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>

    • mergeUnknownFields

      public final CommonResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CommonResponse.Builder>