envoy.api.v2.route

Interface RouteOuterClass.RedirectActionOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RouteOuterClass.RedirectAction, RouteOuterClass.RedirectAction.Builder

Enclosing class:

RouteOuterClass

public static interface RouteOuterClass.RedirectActionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
RouteOuterClass.RedirectAction.PathRewriteSpecifierCase	getPathRewriteSpecifierCase()
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.
RouteOuterClass.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.
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

getHostRedirect

String getHostRedirect()

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

string host_redirect = 1;

getHostRedirectBytes

com.google.protobuf.ByteString getHostRedirectBytes()

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

string host_redirect = 1;

getPathRedirect

String getPathRedirect()

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

string path_redirect = 2;

getPathRedirectBytes

com.google.protobuf.ByteString getPathRedirectBytes()

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

string path_redirect = 2;

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;

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;

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

RouteOuterClass.RedirectAction.RedirectResponseCode getResponseCode()

 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) = { ... }

getHttpsRedirect

boolean getHttpsRedirect()

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

bool https_redirect = 4;

getStripQuery

boolean getStripQuery()

 Indicates that during redirection, the query portion of the URL will
 be removed. Default value is false.
 

bool strip_query = 6;

getPathRewriteSpecifierCase

RouteOuterClass.RedirectAction.PathRewriteSpecifierCase getPathRewriteSpecifierCase()