Compute Engine v1 API - Class HttpRedirectAction (2.9.0)

public sealed class HttpRedirectAction : IMessage<HttpRedirectAction>, IEquatable<HttpRedirectAction>, IDeepCloneable<HttpRedirectAction>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class HttpRedirectAction.

Specifies settings for an HTTP redirect.

Inheritance

object > HttpRedirectAction

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

HttpRedirectAction()

public HttpRedirectAction()

HttpRedirectAction(HttpRedirectAction)

public HttpRedirectAction(HttpRedirectAction other)
Parameter
NameDescription
otherHttpRedirectAction

Properties

HasHostRedirect

public bool HasHostRedirect { get; }

Gets whether the "host_redirect" field is set

Property Value
TypeDescription
bool

HasHttpsRedirect

public bool HasHttpsRedirect { get; }

Gets whether the "https_redirect" field is set

Property Value
TypeDescription
bool

HasPathRedirect

public bool HasPathRedirect { get; }

Gets whether the "path_redirect" field is set

Property Value
TypeDescription
bool

HasPrefixRedirect

public bool HasPrefixRedirect { get; }

Gets whether the "prefix_redirect" field is set

Property Value
TypeDescription
bool

HasRedirectResponseCode

public bool HasRedirectResponseCode { get; }

Gets whether the "redirect_response_code" field is set

Property Value
TypeDescription
bool

HasStripQuery

public bool HasStripQuery { get; }

Gets whether the "strip_query" field is set

Property Value
TypeDescription
bool

HostRedirect

public string HostRedirect { get; set; }

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.

Property Value
TypeDescription
string

HttpsRedirect

public bool HttpsRedirect { get; set; }

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.

Property Value
TypeDescription
bool

PathRedirect

public string PathRedirect { get; set; }

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.

Property Value
TypeDescription
string

PrefixRedirect

public string PrefixRedirect { get; set; }

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.

Property Value
TypeDescription
string

RedirectResponseCode

public string RedirectResponseCode { get; set; }

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - 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. Check the RedirectResponseCode enum for the list of possible values.

Property Value
TypeDescription
string

StripQuery

public bool StripQuery { get; set; }

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.

Property Value
TypeDescription
bool