RegionUrlMapUrlRedirect class

default_url_redirect / path_rule.url_redirect / route_rules.url_redirect block. Returns an HTTP redirect to the client instead of forwarding to a backend.

At least one of hostRedirect / pathRedirect / prefixRedirect / httpsRedirect is typically set; the schema requires stripQuery at the top-level default_url_redirect slot (and accepts it as optional elsewhere -- the wrapper marks it required to keep the most common position safe by default).

Annotations
  • @immutable

Constructors

RegionUrlMapUrlRedirect({required TfArg<bool> stripQuery, TfArg<String>? hostRedirect, TfArg<String>? pathRedirect, TfArg<String>? prefixRedirect, TfArg<bool>? httpsRedirect, TfArg<RegionUrlMapRedirectResponseCode>? redirectResponseCode})
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
hostRedirect → TfArg<String>?
Replacement Host: header for the redirect target. Mutually exclusive with prefixRedirect when both would rewrite the host.
final
httpsRedirect → TfArg<bool>?
Force the redirected URL to https. Useful for HTTP -> HTTPS upgrade URL maps fronting a region_target_http_proxy.
final
pathRedirect → TfArg<String>?
Full replacement path. Mutually exclusive with prefixRedirect.
final
prefixRedirect → TfArg<String>?
Replace the matched prefix with this value. Mutually exclusive with pathRedirect.
final
redirectResponseCode → TfArg<RegionUrlMapRedirectResponseCode>?
HTTP redirect status code. Defaults to RegionUrlMapRedirectResponseCode.movedPermanentlyDefault (HTTP 301) on the API side when omitted.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stripQuery → TfArg<bool>
Whether to drop the request query string before redirecting. Required by the schema at the URL-map-level default_url_redirect slot.
final

Methods

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

Operators

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