HttpRouteRedirectResponse class

The specification for redirecting traffic.

Constructors

HttpRouteRedirectResponse({required Input<String> hostRedirect, required Input<bool> httpsRedirect, required Input<String> pathRedirect, required Input<int> portRedirect, required Input<String> prefixRewrite, required Input<String> responseCode, required Input<bool> stripQuery})
Creates a new HttpRouteRedirectResponse. hostRedirect The host that will be used in the redirect response instead of the one that was supplied in the request. httpsRedirect If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false. pathRedirect The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. portRedirect The port that will be used in the redirected request instead of the one that was supplied in the request. prefixRewrite Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request. responseCode The HTTP Status code to use for the redirect. stripQuery if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
const
HttpRouteRedirectResponse.fromMap(Map<String, dynamic> map)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
hostRedirect → Input<String>
The host that will be used in the redirect response instead of the one that was supplied in the request.
final
httpsRedirect → Input<bool>
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
final
pathRedirect → Input<String>
The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
final
portRedirect → Input<int>
The port that will be used in the redirected request instead of the one that was supplied in the request.
final
prefixRewrite → Input<String>
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
final
responseCode → Input<String>
The HTTP Status code to use for the redirect.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stripQuery → Input<bool>
if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited