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

Interface FilterConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FilterConfig, FilterConfig.Builder
    public interface FilterConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getContentType()
      The content-type to pass to the upstream when the gRPC bridge filter is applied.
      com.google.protobuf.ByteString getContentTypeBytes()
      The content-type to pass to the upstream when the gRPC bridge filter is applied.
      String getResponseSizeHeader()
      When :ref:`withhold_grpc_frames <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.withhold_grpc_frames>` is true, this option controls how Envoy calculates the ``Content-Length``.
      com.google.protobuf.ByteString getResponseSizeHeaderBytes()
      When :ref:`withhold_grpc_frames <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.withhold_grpc_frames>` is true, this option controls how Envoy calculates the ``Content-Length``.
      boolean getWithholdGrpcFrames()
      If true, Envoy will assume that the upstream doesn't understand gRPC frames and strip the gRPC frame from the request, and add it back in to the response.

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

      • getContentType

        String getContentType()
         The content-type to pass to the upstream when the gRPC bridge filter is applied.
 The filter will also validate that the upstream responds with the same content type.
        string content_type = 1 [(.validate.rules) = { ... }
        Returns:
        The contentType.

      • getContentTypeBytes

        com.google.protobuf.ByteString getContentTypeBytes()
         The content-type to pass to the upstream when the gRPC bridge filter is applied.
 The filter will also validate that the upstream responds with the same content type.
        string content_type = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for contentType.

      • getWithholdGrpcFrames

        boolean getWithholdGrpcFrames()
         If true, Envoy will assume that the upstream doesn't understand gRPC frames and
 strip the gRPC frame from the request, and add it back in to the response. This will
 hide the gRPC semantics from the upstream, allowing it to receive and respond with a
 simple binary encoded protobuf. In order to calculate the ``Content-Length`` header value, Envoy
 will buffer the upstream response unless :ref:`response_size_header
 <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.response_size_header>`
 is set, in which case Envoy will use the value of an upstream header to calculate the content
 length.
        bool withhold_grpc_frames = 2;
        Returns:
        The withholdGrpcFrames.

      • getResponseSizeHeader

        String getResponseSizeHeader()
         When :ref:`withhold_grpc_frames
 <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.withhold_grpc_frames>`
 is true, this option controls how Envoy calculates the ``Content-Length``. When
 ``response_size_header`` is empty, Envoy will buffer the upstream response to calculate its
 size. When ``response_size_header`` is set to a non-empty string, Envoy will stream the response
 to the downstream and it will use the value of the response header with this name to set the
 ``Content-Length`` header and gRPC frame size. If the header with this name is repeated, only
 the first value will be used.
 Envoy will treat the upstream response as an error if this option is specified and the header
 is missing or if the value does not match the actual response body size.
        string response_size_header = 3 [(.validate.rules) = { ... }
        Returns:
        The responseSizeHeader.

      • getResponseSizeHeaderBytes

        com.google.protobuf.ByteString getResponseSizeHeaderBytes()
         When :ref:`withhold_grpc_frames
 <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.withhold_grpc_frames>`
 is true, this option controls how Envoy calculates the ``Content-Length``. When
 ``response_size_header`` is empty, Envoy will buffer the upstream response to calculate its
 size. When ``response_size_header`` is set to a non-empty string, Envoy will stream the response
 to the downstream and it will use the value of the response header with this name to set the
 ``Content-Length`` header and gRPC frame size. If the header with this name is repeated, only
 the first value will be used.
 Envoy will treat the upstream response as an error if this option is specified and the header
 is missing or if the value does not match the actual response body size.
        string response_size_header = 3 [(.validate.rules) = { ... }
        Returns:
        The bytes for responseSizeHeader.