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

Interface BodyTransformationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BodyTransformation, BodyTransformation.Builder
public interface BodyTransformationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    BodyTransformation.TransformAction
    getAction()
    The action to perform for new body content and original body content.
    int
    getActionValue()
    The action to perform for new body content and original body content.
    SubstitutionFormatString
    getBodyFormat()
    Body transformation configuration.
    SubstitutionFormatStringOrBuilder
    getBodyFormatOrBuilder()
    Body transformation configuration.
    boolean
    hasBodyFormat()
    Body transformation configuration.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasBodyFormat

      boolean hasBodyFormat()
       Body transformation configuration. The substitution format string is used as the template
 to generate the transformed new body content.
 The :ref:`substitution format specifier <config_access_log_format>` could be applied here.
 And except the commonly used format specifiers, the additional format specifiers
 ``%REQUEST_BODY(KEY*)%`` and ``%RESPONSE_BODY(KEY*)%`` could also be used here.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the bodyFormat field is set.

    • getBodyFormat

      SubstitutionFormatString getBodyFormat()
       Body transformation configuration. The substitution format string is used as the template
 to generate the transformed new body content.
 The :ref:`substitution format specifier <config_access_log_format>` could be applied here.
 And except the commonly used format specifiers, the additional format specifiers
 ``%REQUEST_BODY(KEY*)%`` and ``%RESPONSE_BODY(KEY*)%`` could also be used here.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 1 [(.validate.rules) = { ... }
      Returns:
      The bodyFormat.

    • getBodyFormatOrBuilder

      SubstitutionFormatStringOrBuilder getBodyFormatOrBuilder()
       Body transformation configuration. The substitution format string is used as the template
 to generate the transformed new body content.
 The :ref:`substitution format specifier <config_access_log_format>` could be applied here.
 And except the commonly used format specifiers, the additional format specifiers
 ``%REQUEST_BODY(KEY*)%`` and ``%RESPONSE_BODY(KEY*)%`` could also be used here.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 1 [(.validate.rules) = { ... }

    • getActionValue

      int getActionValue()
       The action to perform for new body content and original body content.
 For example, if ``MERGE`` is used, then the new body content generated from the ``body_format``
 will be merged into the original body content.

 Default is ``MERGE``.
      .envoy.extensions.filters.http.transform.v3.BodyTransformation.TransformAction action = 2;
      Returns:
      The enum numeric value on the wire for action.

    • getAction

      BodyTransformation.TransformAction getAction()
       The action to perform for new body content and original body content.
 For example, if ``MERGE`` is used, then the new body content generated from the ``body_format``
 will be merged into the original body content.

 Default is ``MERGE``.
      .envoy.extensions.filters.http.transform.v3.BodyTransformation.TransformAction action = 2;
      Returns:
      The action.