Package io.envoyproxy.envoy.config.route.v3

Interface DirectResponseActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DirectResponseAction, DirectResponseAction.Builder
public interface DirectResponseActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    DataSource
    getBody()
    Specifies the content of the response body.
    SubstitutionFormatString
    getBodyFormat()
    Specifies a format string for the response body.
    SubstitutionFormatStringOrBuilder
    getBodyFormatOrBuilder()
    Specifies a format string for the response body.
    DataSourceOrBuilder
    getBodyOrBuilder()
    Specifies the content of the response body.
    int
    getStatus()
    Specifies the HTTP response status to be returned.
    boolean
    hasBody()
    Specifies the content of the response body.
    boolean
    hasBodyFormat()
    Specifies a format string for the response body.

    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 Details

    • getStatus

      int getStatus()
       Specifies the HTTP response status to be returned.
      uint32 status = 1 [(.validate.rules) = { ... }
      Returns:
      The status.

    • hasBody

      boolean hasBody()
       Specifies the content of the response body. If this setting is omitted,
 no body is included in the generated response.

 .. note::

   Headers can be specified using ``response_headers_to_add`` in the enclosing
   :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` or
   :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.
      .envoy.config.core.v3.DataSource body = 2;
      Returns:
      Whether the body field is set.

    • getBody

      DataSource getBody()
       Specifies the content of the response body. If this setting is omitted,
 no body is included in the generated response.

 .. note::

   Headers can be specified using ``response_headers_to_add`` in the enclosing
   :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` or
   :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.
      .envoy.config.core.v3.DataSource body = 2;
      Returns:
      The body.

    • getBodyOrBuilder

      DataSourceOrBuilder getBodyOrBuilder()
       Specifies the content of the response body. If this setting is omitted,
 no body is included in the generated response.

 .. note::

   Headers can be specified using ``response_headers_to_add`` in the enclosing
   :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` or
   :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.
      .envoy.config.core.v3.DataSource body = 2;

    • hasBodyFormat

      boolean hasBodyFormat()
       Specifies a format string for the response body. If present, the contents of
 ``body_format`` will be formatted and used as the response body, where the
 contents of ``body`` (may be empty) will be passed as the variable ``%LOCAL_REPLY_BODY%``.
 If neither are provided, no body is included in the generated response.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 3;
      Returns:
      Whether the bodyFormat field is set.

    • getBodyFormat

      SubstitutionFormatString getBodyFormat()
       Specifies a format string for the response body. If present, the contents of
 ``body_format`` will be formatted and used as the response body, where the
 contents of ``body`` (may be empty) will be passed as the variable ``%LOCAL_REPLY_BODY%``.
 If neither are provided, no body is included in the generated response.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 3;
      Returns:
      The bodyFormat.

    • getBodyFormatOrBuilder

      SubstitutionFormatStringOrBuilder getBodyFormatOrBuilder()
       Specifies a format string for the response body. If present, the contents of
 ``body_format`` will be formatted and used as the response body, where the
 contents of ``body`` (may be empty) will be passed as the variable ``%LOCAL_REPLY_BODY%``.
 If neither are provided, no body is included in the generated response.
      .envoy.config.core.v3.SubstitutionFormatString body_format = 3;