Reference documentation and code samples for the Google Cloud Network Services V1 Client class Redirect.
The specification for redirecting traffic.
Generated from protobuf message google.cloud.networkservices.v1.HttpRoute.Redirect
Namespace
Google \ Cloud \ NetworkServices \ V1 \ HttpRouteMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ host_redirect |
string
The host that will be used in the redirect response instead of the one that was supplied in the request. |
↳ path_redirect |
string
The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. |
↳ prefix_rewrite |
string
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request. |
↳ response_code |
int
The HTTP Status code to use for the redirect. |
↳ 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 will remain the same as that of the request. The default is set to false. |
↳ strip_query |
bool
if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. |
↳ port_redirect |
int
The port that will be used in the redirected request instead of the one that was supplied in the request. |
getHostRedirect
The host that will be used in the redirect response instead of the one that was supplied in the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setHostRedirect
The host that will be used in the redirect response instead of the one that was supplied in the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPathRedirect
The path that will be used in the redirect response instead of the one that was supplied in the request.
path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPathRedirect
The path that will be used in the redirect response instead of the one that was supplied in the request.
path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrefixRewrite
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrefixRewrite
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseCode
The HTTP Status code to use for the redirect.
| Returns | |
|---|---|
| Type | Description |
int |
|
setResponseCode
The HTTP Status code to use for the redirect.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 will remain the same as that of the request. The default is set to false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
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 will remain the same as that of the request. The default is set to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStripQuery
if set to true, any accompanying query portion of the original URL is removed prior to 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 |
|
setStripQuery
if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.
The default is set to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPortRedirect
The port that will be used in the redirected request instead of the one that was supplied in the request.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPortRedirect
The port that will be used in the redirected request instead of the one that was supplied in the request.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|