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

Class LocalReplyConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalReplyConfigOrBuilder, Serializable
    public final class LocalReplyConfig
extends com.google.protobuf.GeneratedMessageV3
implements LocalReplyConfigOrBuilder
     The configuration to customize local reply returned by Envoy.
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.LocalReplyConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LocalReplyConfig.Builder
      The configuration to customize local reply returned by Envoy.

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BODY_FORMAT_FIELD_NUMBER  
      static int MAPPERS_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • 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

      • getMappersList

        public List<ResponseMapper> getMappersList()
         Configuration of list of mappers which allows to filter and change local response.
 The mappers will be checked by the specified order until one is matched.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper mappers = 1;
        Specified by:
        getMappersList in interface LocalReplyConfigOrBuilder

      • getMappersOrBuilderList

        public List<? extends ResponseMapperOrBuilder> getMappersOrBuilderList()
         Configuration of list of mappers which allows to filter and change local response.
 The mappers will be checked by the specified order until one is matched.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper mappers = 1;
        Specified by:
        getMappersOrBuilderList in interface LocalReplyConfigOrBuilder

      • getMappersCount

        public int getMappersCount()
         Configuration of list of mappers which allows to filter and change local response.
 The mappers will be checked by the specified order until one is matched.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper mappers = 1;
        Specified by:
        getMappersCount in interface LocalReplyConfigOrBuilder

      • getMappers

        public ResponseMapper getMappers​(int index)
         Configuration of list of mappers which allows to filter and change local response.
 The mappers will be checked by the specified order until one is matched.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper mappers = 1;
        Specified by:
        getMappers in interface LocalReplyConfigOrBuilder

      • getMappersOrBuilder

        public ResponseMapperOrBuilder getMappersOrBuilder​(int index)
         Configuration of list of mappers which allows to filter and change local response.
 The mappers will be checked by the specified order until one is matched.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper mappers = 1;
        Specified by:
        getMappersOrBuilder in interface LocalReplyConfigOrBuilder

      • hasBodyFormat

        public boolean hasBodyFormat()
         The configuration to form response body from the :ref:`command operators <config_access_log_command_operators>`
 and to specify response content type as one of: plain/text or application/json.
 Example one: "plain/text" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"
 The following response body in "plain/text" format will be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: text
   upstream connect error:503:path=/foo
 Example two: "application/json" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   json_format:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"
     path: "%REQ(:path)%"
 The following response body in "application/json" format would be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: json
  {
    "status": 503,
    "message": "upstream connection error",
    "path": "/foo"
  }
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;
        Specified by:
        hasBodyFormat in interface LocalReplyConfigOrBuilder
        Returns:
        Whether the bodyFormat field is set.

      • getBodyFormat

        public SubstitutionFormatString getBodyFormat()
         The configuration to form response body from the :ref:`command operators <config_access_log_command_operators>`
 and to specify response content type as one of: plain/text or application/json.
 Example one: "plain/text" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"
 The following response body in "plain/text" format will be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: text
   upstream connect error:503:path=/foo
 Example two: "application/json" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   json_format:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"
     path: "%REQ(:path)%"
 The following response body in "application/json" format would be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: json
  {
    "status": 503,
    "message": "upstream connection error",
    "path": "/foo"
  }
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;
        Specified by:
        getBodyFormat in interface LocalReplyConfigOrBuilder
        Returns:
        The bodyFormat.

      • getBodyFormatOrBuilder

        public SubstitutionFormatStringOrBuilder getBodyFormatOrBuilder()
         The configuration to form response body from the :ref:`command operators <config_access_log_command_operators>`
 and to specify response content type as one of: plain/text or application/json.
 Example one: "plain/text" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"
 The following response body in "plain/text" format will be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: text
   upstream connect error:503:path=/foo
 Example two: "application/json" ``body_format``.
 .. validated-code-block:: yaml
   :type-name: envoy.config.core.v3.SubstitutionFormatString
   json_format:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"
     path: "%REQ(:path)%"
 The following response body in "application/json" format would be generated for a request with
 local reply body of "upstream connection error", response_code=503 and path=/foo.
 .. code-block:: json
  {
    "status": 503,
    "message": "upstream connection error",
    "path": "/foo"
  }
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;
        Specified by:
        getBodyFormatOrBuilder in interface LocalReplyConfigOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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