RedirectActionOrBuilder (api 0.1.28 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RedirectAction, RedirectAction.Builder
```
public interface RedirectActionOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getHostRedirect()` The host portion of the URL will be swapped with this value.
`com.google.protobuf.ByteString`	`getHostRedirectBytes()` The host portion of the URL will be swapped with this value.
`boolean`	`getHttpsRedirect()` The scheme portion of the URL will be swapped with "https".
`String`	`getPathRedirect()` The path portion of the URL will be swapped with this value.
`com.google.protobuf.ByteString`	`getPathRedirectBytes()` The path portion of the URL will be swapped with this value.
`RedirectAction.PathRewriteSpecifierCase`	`getPathRewriteSpecifierCase()`
`int`	`getPortRedirect()` The port value of the URL will be swapped with this value.
`String`	`getPrefixRewrite()` Indicates that during redirection, the matched prefix (or path) should be swapped with this value.
`com.google.protobuf.ByteString`	`getPrefixRewriteBytes()` Indicates that during redirection, the matched prefix (or path) should be swapped with this value.
`RedirectAction.RedirectResponseCode`	`getResponseCode()` The HTTP status code to use in the redirect response.
`int`	`getResponseCodeValue()` The HTTP status code to use in the redirect response.
`String`	`getSchemeRedirect()` The scheme portion of the URL will be swapped with this value.
`com.google.protobuf.ByteString`	`getSchemeRedirectBytes()` The scheme portion of the URL will be swapped with this value.
`RedirectAction.SchemeRewriteSpecifierCase`	`getSchemeRewriteSpecifierCase()`
`boolean`	`getStripQuery()` Indicates that during redirection, the query portion of the URL will be removed.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getHttpsRedirect

boolean getHttpsRedirect()

 The scheme portion of the URL will be swapped with "https".

bool https_redirect = 4;

getSchemeRedirect

String getSchemeRedirect()

 The scheme portion of the URL will be swapped with this value.

string scheme_redirect = 7;

getSchemeRedirectBytes

com.google.protobuf.ByteString getSchemeRedirectBytes()

 The scheme portion of the URL will be swapped with this value.

string scheme_redirect = 7;

getHostRedirect

String getHostRedirect()

 The host portion of the URL will be swapped with this value.

string host_redirect = 1 [(.validate.rules) = { ... }

getHostRedirectBytes

com.google.protobuf.ByteString getHostRedirectBytes()

 The host portion of the URL will be swapped with this value.

string host_redirect = 1 [(.validate.rules) = { ... }

getPortRedirect

int getPortRedirect()

 The port value of the URL will be swapped with this value.

uint32 port_redirect = 8;

getPathRedirect

String getPathRedirect()

 The path portion of the URL will be swapped with this value.
 Please note that query string in path_redirect will override the
 request's query string and will not be stripped.
 For example, let's say we have the following routes:
 - match: { path: "/old-path-1" }
   redirect: { path_redirect: "/new-path-1" }
 - match: { path: "/old-path-2" }
   redirect: { path_redirect: "/new-path-2", strip-query: "true" }
 - match: { path: "/old-path-3" }
   redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
 1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
 2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
 3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"

string path_redirect = 2 [(.validate.rules) = { ... }

getPathRedirectBytes

com.google.protobuf.ByteString getPathRedirectBytes()

 The path portion of the URL will be swapped with this value.
 Please note that query string in path_redirect will override the
 request's query string and will not be stripped.
 For example, let's say we have the following routes:
 - match: { path: "/old-path-1" }
   redirect: { path_redirect: "/new-path-1" }
 - match: { path: "/old-path-2" }
   redirect: { path_redirect: "/new-path-2", strip-query: "true" }
 - match: { path: "/old-path-3" }
   redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
 1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
 2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
 3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"

string path_redirect = 2 [(.validate.rules) = { ... }

getPrefixRewrite

String getPrefixRewrite()

 Indicates that during redirection, the matched prefix (or path)
 should be swapped with this value. This option allows redirect URLs be dynamically created
 based on the request.
 .. attention::
   Pay attention to the use of trailing slashes as mentioned in
   :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.

string prefix_rewrite = 5 [(.validate.rules) = { ... }

getPrefixRewriteBytes

com.google.protobuf.ByteString getPrefixRewriteBytes()

 Indicates that during redirection, the matched prefix (or path)
 should be swapped with this value. This option allows redirect URLs be dynamically created
 based on the request.
 .. attention::
   Pay attention to the use of trailing slashes as mentioned in
   :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.

string prefix_rewrite = 5 [(.validate.rules) = { ... }

getResponseCodeValue

int getResponseCodeValue()

 The HTTP status code to use in the redirect response. The default response
 code is MOVED_PERMANENTLY (301).

.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }

getResponseCode

RedirectAction.RedirectResponseCode getResponseCode()

 The HTTP status code to use in the redirect response. The default response
 code is MOVED_PERMANENTLY (301).