Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class ResponseMapper

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResponseMapperOrBuilder, java.io.Serializable
    public final class ResponseMapper
extends com.google.protobuf.GeneratedMessage
implements ResponseMapperOrBuilder
     The configuration to filter and change local response.
 [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResponseMapper.Builder
      The configuration to filter and change local response.

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

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessage.BuilderParent

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ResponseMapper()  
      private ResponseMapper​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Constructor Detail

      • ResponseMapper

        private ResponseMapper​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • ResponseMapper

        private ResponseMapper()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • hasFilter

        public boolean hasFilter()
         Filter to determine if this mapper should apply.
        .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
        Specified by:
        hasFilter in interface ResponseMapperOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public AccessLogFilter getFilter()
         Filter to determine if this mapper should apply.
        .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
        Specified by:
        getFilter in interface ResponseMapperOrBuilder
        Returns:
        The filter.

      • hasStatusCode

        public boolean hasStatusCode()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
        Specified by:
        hasStatusCode in interface ResponseMapperOrBuilder
        Returns:
        Whether the statusCode field is set.

      • getStatusCode

        public com.google.protobuf.UInt32Value getStatusCode()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
        Specified by:
        getStatusCode in interface ResponseMapperOrBuilder
        Returns:
        The statusCode.

      • getStatusCodeOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getStatusCodeOrBuilder()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
        Specified by:
        getStatusCodeOrBuilder in interface ResponseMapperOrBuilder

      • hasBody

        public boolean hasBody()
         The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%``
 command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 3;
        Specified by:
        hasBody in interface ResponseMapperOrBuilder
        Returns:
        Whether the body field is set.

      • getBody

        public DataSource getBody()
         The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%``
 command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 3;
        Specified by:
        getBody in interface ResponseMapperOrBuilder
        Returns:
        The body.

      • getBodyOrBuilder

        public DataSourceOrBuilder getBodyOrBuilder()
         The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%``
 command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 3;
        Specified by:
        getBodyOrBuilder in interface ResponseMapperOrBuilder

      • hasBodyFormatOverride

        public boolean hasBodyFormatOverride()
         A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.
 It will be used when this mapper is matched.
        .envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
        Specified by:
        hasBodyFormatOverride in interface ResponseMapperOrBuilder
        Returns:
        Whether the bodyFormatOverride field is set.

      • getBodyFormatOverride

        public SubstitutionFormatString getBodyFormatOverride()
         A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.
 It will be used when this mapper is matched.
        .envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
        Specified by:
        getBodyFormatOverride in interface ResponseMapperOrBuilder
        Returns:
        The bodyFormatOverride.

      • getBodyFormatOverrideOrBuilder

        public SubstitutionFormatStringOrBuilder getBodyFormatOverrideOrBuilder()
         A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.
 It will be used when this mapper is matched.
        .envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
        Specified by:
        getBodyFormatOverrideOrBuilder in interface ResponseMapperOrBuilder

      • getHeadersToAddList

        public java.util.List<HeaderValueOption> getHeadersToAddList()
         HTTP headers to add to a local reply. This allows the response mapper to append, to add
 or to override headers of any local reply before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
        Specified by:
        getHeadersToAddList in interface ResponseMapperOrBuilder

      • getHeadersToAddOrBuilderList

        public java.util.List<? extends HeaderValueOptionOrBuilder> getHeadersToAddOrBuilderList()
         HTTP headers to add to a local reply. This allows the response mapper to append, to add
 or to override headers of any local reply before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
        Specified by:
        getHeadersToAddOrBuilderList in interface ResponseMapperOrBuilder

      • getHeadersToAddCount

        public int getHeadersToAddCount()
         HTTP headers to add to a local reply. This allows the response mapper to append, to add
 or to override headers of any local reply before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
        Specified by:
        getHeadersToAddCount in interface ResponseMapperOrBuilder

      • getHeadersToAdd

        public HeaderValueOption getHeadersToAdd​(int index)
         HTTP headers to add to a local reply. This allows the response mapper to append, to add
 or to override headers of any local reply before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
        Specified by:
        getHeadersToAdd in interface ResponseMapperOrBuilder

      • getHeadersToAddOrBuilder

        public HeaderValueOptionOrBuilder getHeadersToAddOrBuilder​(int index)
         HTTP headers to add to a local reply. This allows the response mapper to append, to add
 or to override headers of any local reply before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
        Specified by:
        getHeadersToAddOrBuilder in interface ResponseMapperOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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 ResponseMapper parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static ResponseMapper parseFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ResponseMapper parseFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ResponseMapper parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ResponseMapper parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ResponseMapper parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ResponseMapper.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static ResponseMapper getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ResponseMapper> 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.GeneratedMessage

      • getDefaultInstanceForType

        public ResponseMapper getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder