Package io.envoyproxy.envoy.extensions.filters.http.transform.v3

Class TransformConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<TransformConfig.Builder>
io.envoyproxy.envoy.extensions.filters.http.transform.v3.TransformConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransformConfigOrBuilder, Cloneable
Enclosing class:
TransformConfig
public static final class TransformConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TransformConfig.Builder> implements TransformConfigOrBuilder
 Configuration for the transform filter. The filter may buffer the request/response until the
 entire body is received, and then mutate the headers and body according to the contents
 of the request/response. The request and response transformations are independent and could
 be configured separately.
 Only JSON body transformation is supported for now.
Protobuf type envoy.extensions.filters.http.transform.v3.TransformConfig

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

    • clear

      public TransformConfig.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<TransformConfig.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<TransformConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public TransformConfig.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<TransformConfig.Builder>

    • setField

      public TransformConfig.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<TransformConfig.Builder>

    • clearField

      public TransformConfig.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<TransformConfig.Builder>

    • clearOneof

      public TransformConfig.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<TransformConfig.Builder>

    • setRepeatedField

      public TransformConfig.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<TransformConfig.Builder>

    • addRepeatedField

      public TransformConfig.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<TransformConfig.Builder>

    • mergeFrom

      public TransformConfig.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<TransformConfig.Builder>

    • mergeFrom

      public TransformConfig.Builder mergeFrom(TransformConfig other)

    • isInitialized

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

    • mergeFrom

      public TransformConfig.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<TransformConfig.Builder>
      Throws:
      IOException

    • hasRequestTransformation

      public boolean hasRequestTransformation()
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;
      Specified by:
      hasRequestTransformation in interface TransformConfigOrBuilder
      Returns:
      Whether the requestTransformation field is set.

    • getRequestTransformation

      public Transformation getRequestTransformation()
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;
      Specified by:
      getRequestTransformation in interface TransformConfigOrBuilder
      Returns:
      The requestTransformation.

    • setRequestTransformation

      public TransformConfig.Builder setRequestTransformation(Transformation value)
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;

    • setRequestTransformation

      public TransformConfig.Builder setRequestTransformation(Transformation.Builder builderForValue)
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;

    • mergeRequestTransformation

      public TransformConfig.Builder mergeRequestTransformation(Transformation value)
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;

    • clearRequestTransformation

      public TransformConfig.Builder clearRequestTransformation()
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;

    • getRequestTransformationBuilder

      public Transformation.Builder getRequestTransformationBuilder()
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;

    • getRequestTransformationOrBuilder

      public TransformationOrBuilder getRequestTransformationOrBuilder()
       Configuration for transforming request.

 .. note::

   If set then the entire request headers and body will always be buffered on a JSON request
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation request_transformation = 1;
      Specified by:
      getRequestTransformationOrBuilder in interface TransformConfigOrBuilder

    • hasResponseTransformation

      public boolean hasResponseTransformation()
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;
      Specified by:
      hasResponseTransformation in interface TransformConfigOrBuilder
      Returns:
      Whether the responseTransformation field is set.

    • getResponseTransformation

      public Transformation getResponseTransformation()
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;
      Specified by:
      getResponseTransformation in interface TransformConfigOrBuilder
      Returns:
      The responseTransformation.

    • setResponseTransformation

      public TransformConfig.Builder setResponseTransformation(Transformation value)
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;

    • setResponseTransformation

      public TransformConfig.Builder setResponseTransformation(Transformation.Builder builderForValue)
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;

    • mergeResponseTransformation

      public TransformConfig.Builder mergeResponseTransformation(Transformation value)
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;

    • clearResponseTransformation

      public TransformConfig.Builder clearResponseTransformation()
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;

    • getResponseTransformationBuilder

      public Transformation.Builder getResponseTransformationBuilder()
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;

    • getResponseTransformationOrBuilder

      public TransformationOrBuilder getResponseTransformationOrBuilder()
       Configuration for transforming response.

 .. note::

   If set then the entire response headers and body will always be buffered on a JSON response
   even if only headers are transformed.
      .envoy.extensions.filters.http.transform.v3.Transformation response_transformation = 2;
      Specified by:
      getResponseTransformationOrBuilder in interface TransformConfigOrBuilder

    • getClearClusterCache

      public boolean getClearClusterCache()
       If true and the request headers are transformed, Envoy will re-evaluate the target
 cluster in the same route. Please ensure the cluster specifier in the route supports
 dynamic evaluation or this flag will have no effect, e.g.
 :ref:`matcher cluster specifier
 <envoy_v3_api_msg_extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier>`.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_cluster_cache = 3;
      Specified by:
      getClearClusterCache in interface TransformConfigOrBuilder
      Returns:
      The clearClusterCache.

    • setClearClusterCache

      public TransformConfig.Builder setClearClusterCache(boolean value)
       If true and the request headers are transformed, Envoy will re-evaluate the target
 cluster in the same route. Please ensure the cluster specifier in the route supports
 dynamic evaluation or this flag will have no effect, e.g.
 :ref:`matcher cluster specifier
 <envoy_v3_api_msg_extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier>`.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_cluster_cache = 3;
      Parameters:
      value - The clearClusterCache to set.
      Returns:
      This builder for chaining.

    • clearClearClusterCache

      public TransformConfig.Builder clearClearClusterCache()
       If true and the request headers are transformed, Envoy will re-evaluate the target
 cluster in the same route. Please ensure the cluster specifier in the route supports
 dynamic evaluation or this flag will have no effect, e.g.
 :ref:`matcher cluster specifier
 <envoy_v3_api_msg_extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier>`.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_cluster_cache = 3;
      Returns:
      This builder for chaining.

    • getClearRouteCache

      public boolean getClearRouteCache()
       If true and the request headers are transformed, Envoy will clear the route cache for
 the current request and force re-evaluation of the route. This has performance penalty and
 should only be used when the route match criteria depends on the transformed headers.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_route_cache = 4;
      Specified by:
      getClearRouteCache in interface TransformConfigOrBuilder
      Returns:
      The clearRouteCache.

    • setClearRouteCache

      public TransformConfig.Builder setClearRouteCache(boolean value)
       If true and the request headers are transformed, Envoy will clear the route cache for
 the current request and force re-evaluation of the route. This has performance penalty and
 should only be used when the route match criteria depends on the transformed headers.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_route_cache = 4;
      Parameters:
      value - The clearRouteCache to set.
      Returns:
      This builder for chaining.

    • clearClearRouteCache

      public TransformConfig.Builder clearClearRouteCache()
       If true and the request headers are transformed, Envoy will clear the route cache for
 the current request and force re-evaluation of the route. This has performance penalty and
 should only be used when the route match criteria depends on the transformed headers.

 Only one of ``clear_cluster_cache`` and ``clear_route_cache`` can be true.
      bool clear_route_cache = 4;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final TransformConfig.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<TransformConfig.Builder>

    • mergeUnknownFields

      public final TransformConfig.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<TransformConfig.Builder>