Compute V1 Client - Class HttpRedirectAction (1.17.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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`bool`

hasHttpsRedirect

clearHttpsRedirect

setHttpsRedirect

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasPathRedirect

clearPathRedirect

setPathRedirect

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasPrefixRedirect

clearPrefixRedirect

setPrefixRedirect

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasRedirectResponseCode

clearRedirectResponseCode

setRedirectResponseCode

Check the RedirectResponseCode enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`bool`

hasStripQuery

clearStripQuery

setStripQuery

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`