HttpRedirectAction

import type { HttpRedirectAction } from "https://googleapis.deno.dev/v1/compute:v1.ts";

Specifies settings for an HTTP redirect.

interface HttpRedirectAction {

hostRedirect?: string;

httpsRedirect?: boolean;

pathRedirect?: string;

prefixRedirect?: string;

redirectResponseCode?:

| "FOUND"

| "MOVED_PERMANENTLY_DEFAULT"

| "PERMANENT_REDIRECT"

| "SEE_OTHER"

| "TEMPORARY_REDIRECT";

stripQuery?: boolean;

}

§Properties

hostRedirect?: string

[src]

The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.

httpsRedirect?: boolean

[src]

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 remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

pathRedirect?: string

[src]

The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

prefixRedirect?: string

[src]

The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.

redirectResponseCode?: "FOUND" | "MOVED_PERMANENTLY_DEFAULT" | "PERMANENT_REDIRECT" | "SEE_OTHER" | "TEMPORARY_REDIRECT"

[src]

The HTTP Status code to use for this RedirectAction. Supported values are:

MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to

- FOUND, which corresponds to 302. - SEE_OTHER which corresponds to
- TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.

stripQuery?: boolean

[src]

If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.