Compute V1 Client - Class HttpRedirectAction (1.5.0)

Reference documentation and code samples for the Compute V1 Client class HttpRedirectAction.

Specifies settings for an HTTP redirect.

Generated from protobuf message google.cloud.compute.v1.HttpRedirectAction

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ host_redirect string

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.

↳ https_redirect 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 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.

↳ path_redirect string

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.

↳ prefix_redirect string

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.

↳ redirect_response_code string

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.

↳ strip_query bool

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.

getHostRedirect

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.

Generated from protobuf field optional string host_redirect = 107417747;

Returns
TypeDescription
string

hasHostRedirect

clearHostRedirect

setHostRedirect

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.

Generated from protobuf field optional string host_redirect = 107417747;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHttpsRedirect

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.

Generated from protobuf field optional bool https_redirect = 170260656;

Returns
TypeDescription
bool

hasHttpsRedirect

clearHttpsRedirect

setHttpsRedirect

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.

Generated from protobuf field optional bool https_redirect = 170260656;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPathRedirect

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.

Generated from protobuf field optional string path_redirect = 272342710;

Returns
TypeDescription
string

hasPathRedirect

clearPathRedirect

setPathRedirect

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.

Generated from protobuf field optional string path_redirect = 272342710;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPrefixRedirect

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.

Generated from protobuf field optional string prefix_redirect = 446184169;

Returns
TypeDescription
string

hasPrefixRedirect

clearPrefixRedirect

setPrefixRedirect

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.

Generated from protobuf field optional string prefix_redirect = 446184169;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRedirectResponseCode

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.

Generated from protobuf field optional string redirect_response_code = 436710408;

Returns
TypeDescription
string

hasRedirectResponseCode

clearRedirectResponseCode

setRedirectResponseCode

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.

Generated from protobuf field optional string redirect_response_code = 436710408;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStripQuery

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.

Generated from protobuf field optional bool strip_query = 52284641;

Returns
TypeDescription
bool

hasStripQuery

clearStripQuery

setStripQuery

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.

Generated from protobuf field optional bool strip_query = 52284641;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this