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

Interface TransformConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransformConfig, TransformConfig.Builder

public interface TransformConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
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.
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.
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.

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

hasRequestTransformation

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;

Returns:

Whether the requestTransformation field is set.

getRequestTransformation

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;

Returns:

The requestTransformation.

getRequestTransformationOrBuilder

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;

hasResponseTransformation

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;

Returns:

Whether the responseTransformation field is set.

getResponseTransformation

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;

Returns:

The responseTransformation.

getResponseTransformationOrBuilder

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;

getClearClusterCache

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;

Returns:

The clearClusterCache.

getClearRouteCache

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;

Returns:

The clearRouteCache.