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

Interface RedirectPolicyOrBuilder

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

  • Method Details

    • hasUri

      boolean hasUri()
       The Http URI to redirect the original request to, to get the custom
 response.
 It should be a full FQDN with protocol, host and path.

 Example:

 .. code-block:: yaml

    uri: https://www.mydomain.com/path/to/404.txt
      string uri = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the uri field is set.

    • getUri

      String getUri()
       The Http URI to redirect the original request to, to get the custom
 response.
 It should be a full FQDN with protocol, host and path.

 Example:

 .. code-block:: yaml

    uri: https://www.mydomain.com/path/to/404.txt
      string uri = 1 [(.validate.rules) = { ... }
      Returns:
      The uri.

    • getUriBytes

      com.google.protobuf.ByteString getUriBytes()
       The Http URI to redirect the original request to, to get the custom
 response.
 It should be a full FQDN with protocol, host and path.

 Example:

 .. code-block:: yaml

    uri: https://www.mydomain.com/path/to/404.txt
      string uri = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for uri.

    • hasRedirectAction

      boolean hasRedirectAction()
       Specify elements of the redirect url individually.
 Note: Do not specify the ``response_code`` field in ``redirect_action``, use
 ``status_code`` instead.
 The following fields in ``redirect_action`` are currently not supported,
 and specifying them will cause the config to be rejected:
 - ``prefix_rewrite``
 - ``regex_rewrite``
      .envoy.config.route.v3.RedirectAction redirect_action = 2;
      Returns:
      Whether the redirectAction field is set.

    • getRedirectAction

      RedirectAction getRedirectAction()
       Specify elements of the redirect url individually.
 Note: Do not specify the ``response_code`` field in ``redirect_action``, use
 ``status_code`` instead.
 The following fields in ``redirect_action`` are currently not supported,
 and specifying them will cause the config to be rejected:
 - ``prefix_rewrite``
 - ``regex_rewrite``
      .envoy.config.route.v3.RedirectAction redirect_action = 2;
      Returns:
      The redirectAction.

    • getRedirectActionOrBuilder

      RedirectActionOrBuilder getRedirectActionOrBuilder()
       Specify elements of the redirect url individually.
 Note: Do not specify the ``response_code`` field in ``redirect_action``, use
 ``status_code`` instead.
 The following fields in ``redirect_action`` are currently not supported,
 and specifying them will cause the config to be rejected:
 - ``prefix_rewrite``
 - ``regex_rewrite``
      .envoy.config.route.v3.RedirectAction redirect_action = 2;

    • hasStatusCode

      boolean hasStatusCode()
       The new response status code if specified. This is used to override the
 status code of the response from the new upstream if it is not an error status.
      .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. This is used to override the
 status code of the response from the new upstream if it is not an error status.
      .google.protobuf.UInt32Value status_code = 3 [(.validate.rules) = { ... }
      Returns:
      The statusCode.

    • getStatusCodeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getStatusCodeOrBuilder()
       The new response status code if specified. This is used to override the
 status code of the response from the new upstream if it is not an error status.
      .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.
 Note that these are not applied if the redirected response is an error
 response.
      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.
 Note that these are not applied if the redirected response is an error
 response.
      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.
 Note that these are not applied if the redirected response is an error
 response.
      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.
 Note that these are not applied if the redirected response is an error
 response.
      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.
 Note that these are not applied if the redirected response is an error
 response.
      repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

    • getRequestHeadersToAddList

      List<HeaderValueOption> getRequestHeadersToAddList()
       HTTP headers to add to the request before it is internally redirected.
      repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 5 [(.validate.rules) = { ... }

    • getRequestHeadersToAdd

      HeaderValueOption getRequestHeadersToAdd(int index)
       HTTP headers to add to the request before it is internally redirected.
      repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 5 [(.validate.rules) = { ... }

    • getRequestHeadersToAddCount

      int getRequestHeadersToAddCount()
       HTTP headers to add to the request before it is internally redirected.
      repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 5 [(.validate.rules) = { ... }

    • getRequestHeadersToAddOrBuilderList

      List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()
       HTTP headers to add to the request before it is internally redirected.
      repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 5 [(.validate.rules) = { ... }

    • getRequestHeadersToAddOrBuilder

      HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)
       HTTP headers to add to the request before it is internally redirected.
      repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 5 [(.validate.rules) = { ... }

    • hasModifyRequestHeadersAction

      boolean hasModifyRequestHeadersAction()
       Custom action to modify request headers before selection of the
 redirected route.
 [#comment: TODO(pradeepcrao) add an extension category.]
      .envoy.config.core.v3.TypedExtensionConfig modify_request_headers_action = 6;
      Returns:
      Whether the modifyRequestHeadersAction field is set.

    • getModifyRequestHeadersAction

      TypedExtensionConfig getModifyRequestHeadersAction()
       Custom action to modify request headers before selection of the
 redirected route.
 [#comment: TODO(pradeepcrao) add an extension category.]
      .envoy.config.core.v3.TypedExtensionConfig modify_request_headers_action = 6;
      Returns:
      The modifyRequestHeadersAction.

    • getModifyRequestHeadersActionOrBuilder

      TypedExtensionConfigOrBuilder getModifyRequestHeadersActionOrBuilder()
       Custom action to modify request headers before selection of the
 redirected route.
 [#comment: TODO(pradeepcrao) add an extension category.]
      .envoy.config.core.v3.TypedExtensionConfig modify_request_headers_action = 6;

    • getRedirectActionSpecifierCase

      RedirectPolicy.RedirectActionSpecifierCase getRedirectActionSpecifierCase()