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

Class FilterConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterConfigOrBuilder, Serializable
    public final class FilterConfig
extends com.google.protobuf.GeneratedMessageV3
implements FilterConfigOrBuilder
     gRPC reverse bridge filter configuration
    Protobuf type envoy.extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FilterConfig.Builder
      gRPC reverse bridge filter configuration

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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.
      static FilterConfig getDefaultInstance()  
      FilterConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<FilterConfig> getParserForType()  
      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``.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      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.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static FilterConfig.Builder newBuilder()  
      static FilterConfig.Builder newBuilder​(FilterConfig prototype)  
      FilterConfig.Builder newBuilderForType()  
      protected FilterConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static FilterConfig parseDelimitedFrom​(InputStream input)  
      static FilterConfig parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FilterConfig parseFrom​(byte[] data)  
      static FilterConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FilterConfig parseFrom​(com.google.protobuf.ByteString data)  
      static FilterConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FilterConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static FilterConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FilterConfig parseFrom​(InputStream input)  
      static FilterConfig parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FilterConfig parseFrom​(ByteBuffer data)  
      static FilterConfig parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<FilterConfig> parser()  
      FilterConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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 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, hasField, hasOneof

    • Field Detail

      • CONTENT_TYPE_FIELD_NUMBER

        public static final int CONTENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WITHHOLD_GRPC_FRAMES_FIELD_NUMBER

        public static final int WITHHOLD_GRPC_FRAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_SIZE_HEADER_FIELD_NUMBER

        public static final int RESPONSE_SIZE_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getContentType

        public 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) = { ... }
        Specified by:
        getContentType in interface FilterConfigOrBuilder
        Returns:
        The contentType.

      • getContentTypeBytes

        public 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) = { ... }
        Specified by:
        getContentTypeBytes in interface FilterConfigOrBuilder
        Returns:
        The bytes for contentType.

      • getWithholdGrpcFrames

        public 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;
        Specified by:
        getWithholdGrpcFrames in interface FilterConfigOrBuilder
        Returns:
        The withholdGrpcFrames.

      • getResponseSizeHeader

        public 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) = { ... }
        Specified by:
        getResponseSizeHeader in interface FilterConfigOrBuilder
        Returns:
        The responseSizeHeader.

      • getResponseSizeHeaderBytes

        public 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) = { ... }
        Specified by:
        getResponseSizeHeaderBytes in interface FilterConfigOrBuilder
        Returns:
        The bytes for responseSizeHeader.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static FilterConfig getDefaultInstance()

      • parser

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

      • getParserForType

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