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

Class TransformConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.transform.v3.TransformConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransformConfigOrBuilder, Serializable
public final class TransformConfig extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TransformConfig.Builder
    Configuration for the transform filter.

    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
    CLEAR_CLUSTER_CACHE_FIELD_NUMBER
     
    static final int
    CLEAR_ROUTE_CACHE_FIELD_NUMBER
     
    static final int
    REQUEST_TRANSFORMATION_FIELD_NUMBER
     
    static final int
    RESPONSE_TRANSFORMATION_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)
     
    boolean
    getClearClusterCache()
    If true and the request headers are transformed, Envoy will re-evaluate the target cluster in the same route.
    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.
    static TransformConfig
    getDefaultInstance()
     
    TransformConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<TransformConfig>
    getParserForType()
     
    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.
    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.
    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.
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    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.
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TransformConfig.Builder
    newBuilder()
     
    static TransformConfig.Builder
    newBuilder(TransformConfig prototype)
     
    TransformConfig.Builder
    newBuilderForType()
     
    protected TransformConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static TransformConfig
    parseDelimitedFrom(InputStream input)
     
    static TransformConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TransformConfig
    parseFrom(byte[] data)
     
    static TransformConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TransformConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static TransformConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TransformConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TransformConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TransformConfig
    parseFrom(InputStream input)
     
    static TransformConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TransformConfig
    parseFrom(ByteBuffer data)
     
    static TransformConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TransformConfig>
    parser()
     
    TransformConfig.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

    • REQUEST_TRANSFORMATION_FIELD_NUMBER

      public static final int REQUEST_TRANSFORMATION_FIELD_NUMBER
      See Also:

    • RESPONSE_TRANSFORMATION_FIELD_NUMBER

      public static final int RESPONSE_TRANSFORMATION_FIELD_NUMBER
      See Also:

    • CLEAR_CLUSTER_CACHE_FIELD_NUMBER

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

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

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

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TransformConfig.Builder newBuilder()

    • newBuilder

      public static TransformConfig.Builder newBuilder(TransformConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TransformConfig getDefaultInstance()

    • parser

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

    • getParserForType

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