Package io.envoyproxy.envoy.extensions.http.custom_response.local_response_policy.v3

Interface LocalResponsePolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    LocalResponsePolicy, LocalResponsePolicy.Builder
    public interface LocalResponsePolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasBody

        boolean hasBody()
         Optional new local reply body text. It will be used
 in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 1;
        Returns:
        Whether the body field is set.

      • getBody

        DataSource getBody()
         Optional new local reply body text. It will be used
 in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 1;
        Returns:
        The body.

      • getBodyOrBuilder

        DataSourceOrBuilder getBodyOrBuilder()
         Optional new local reply body text. It will be used
 in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
        .envoy.config.core.v3.DataSource body = 1;

      • hasBodyFormat

        boolean hasBodyFormat()
         Optional body format to be used for this response. If ``body_format`` is  not
 provided, and ``body`` is, the contents of ``body`` will be used to populate
 the body of the local reply without formatting.
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;
        Returns:
        Whether the bodyFormat field is set.

      • getBodyFormat

        SubstitutionFormatString getBodyFormat()
         Optional body format to be used for this response. If ``body_format`` is  not
 provided, and ``body`` is, the contents of ``body`` will be used to populate
 the body of the local reply without formatting.
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;
        Returns:
        The bodyFormat.

      • getBodyFormatOrBuilder

        SubstitutionFormatStringOrBuilder getBodyFormatOrBuilder()
         Optional body format to be used for this response. If ``body_format`` is  not
 provided, and ``body`` is, the contents of ``body`` will be used to populate
 the body of the local reply without formatting.
        .envoy.config.core.v3.SubstitutionFormatString body_format = 2;

      • hasStatusCode

        boolean hasStatusCode()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 3 [(.validate.rules) = { ... }
        Returns:
        Whether the statusCode field is set.

      • getStatusCode

        com.google.protobuf.UInt32Value getStatusCode()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 3 [(.validate.rules) = { ... }
        Returns:
        The statusCode.

      • getStatusCodeOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getStatusCodeOrBuilder()
         The new response status code if specified.
        .google.protobuf.UInt32Value status_code = 3 [(.validate.rules) = { ... }

      • getResponseHeadersToAddList

        List<HeaderValueOption> getResponseHeadersToAddList()
         HTTP headers to add to the response. This allows the
 response policy to append, to add or to override headers of
 the original response for local body, or the custom response from the
 remote body, before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAdd

        HeaderValueOption getResponseHeadersToAdd​(int index)
         HTTP headers to add to the response. This allows the
 response policy to append, to add or to override headers of
 the original response for local body, or the custom response from the
 remote body, before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddCount

        int getResponseHeadersToAddCount()
         HTTP headers to add to the response. This allows the
 response policy to append, to add or to override headers of
 the original response for local body, or the custom response from the
 remote body, before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()
         HTTP headers to add to the response. This allows the
 response policy to append, to add or to override headers of
 the original response for local body, or the custom response from the
 remote body, before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder​(int index)
         HTTP headers to add to the response. This allows the
 response policy to append, to add or to override headers of
 the original response for local body, or the custom response from the
 remote body, before it is sent to a downstream client.
        repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }