Class LocalReplyConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.LocalReplyConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalReplyConfigOrBuilder, Serializable
@Generated public final class LocalReplyConfig extends com.google.protobuf.GeneratedMessage implements LocalReplyConfigOrBuilder
The configuration to customize local reply returned by Envoy.
Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.LocalReplyConfig
See Also:

  • Field Details

  • Constructor Details

    • LocalReplyConfig

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

    • LocalReplyConfig

      private LocalReplyConfig()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • computeSerializedSize_0

      private int computeSerializedSize_0()

    • 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(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static LocalReplyConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LocalReplyConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static LocalReplyConfig.Builder newBuilder()

    • newBuilder

      public static LocalReplyConfig.Builder newBuilder(LocalReplyConfig prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static LocalReplyConfig getDefaultInstance()

    • parser

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

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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