Interface HttpRedirectActionOrBuilder (1.6.0-beta)

Version 1.6.0-beta

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface HttpRedirectActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getHostRedirect()

public abstract String getHostRedirect()

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

optional string host_redirect = 107417747;

Returns

Type	Description
String	The hostRedirect.

getHostRedirectBytes()

public abstract ByteString getHostRedirectBytes()

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

optional string host_redirect = 107417747;

Returns

Type	Description
ByteString	The bytes for hostRedirect.

getHttpsRedirect()

public abstract boolean 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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

optional bool https_redirect = 170260656;

Returns

Type	Description
boolean	The httpsRedirect.

getPathRedirect()

public abstract String getPathRedirect()

The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string path_redirect = 272342710;

Returns

Type	Description
String	The pathRedirect.

getPathRedirectBytes()

public abstract ByteString getPathRedirectBytes()

The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string path_redirect = 272342710;

Returns

Type	Description
ByteString	The bytes for pathRedirect.

getPrefixRedirect()

public abstract String 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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string prefix_redirect = 446184169;

Returns

Type	Description
String	The prefixRedirect.

getPrefixRedirectBytes()

public abstract ByteString getPrefixRedirectBytes()

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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string prefix_redirect = 446184169;

Returns

Type	Description
ByteString	The bytes for prefixRedirect.

getRedirectResponseCode()

public abstract String 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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. Check the RedirectResponseCode enum for the list of possible values.

optional string redirect_response_code = 436710408;

Returns

Type	Description
String	The redirectResponseCode.

getRedirectResponseCodeBytes()

public abstract ByteString getRedirectResponseCodeBytes()

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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. Check the RedirectResponseCode enum for the list of possible values.

optional string redirect_response_code = 436710408;

Returns

Type	Description
ByteString	The bytes for redirectResponseCode.

getStripQuery()

public abstract boolean 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.

optional bool strip_query = 52284641;

Returns

Type	Description
boolean	The stripQuery.

hasHostRedirect()

public abstract boolean hasHostRedirect()

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

optional string host_redirect = 107417747;

Returns

Type	Description
boolean	Whether the hostRedirect field is set.

hasHttpsRedirect()

public abstract boolean hasHttpsRedirect()

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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

optional bool https_redirect = 170260656;

Returns

Type	Description
boolean	Whether the httpsRedirect field is set.

hasPathRedirect()

public abstract boolean hasPathRedirect()

The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string path_redirect = 272342710;

Returns

Type	Description
boolean	Whether the pathRedirect field is set.

hasPrefixRedirect()

public abstract boolean hasPrefixRedirect()

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 will be used for the redirect. The value must be between 1 and 1024 characters.

optional string prefix_redirect = 446184169;

Returns

Type	Description
boolean	Whether the prefixRedirect field is set.

hasRedirectResponseCode()

public abstract boolean hasRedirectResponseCode()

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 will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. Check the RedirectResponseCode enum for the list of possible values.

optional string redirect_response_code = 436710408;

Returns

Type	Description
boolean	Whether the redirectResponseCode field is set.

hasStripQuery()

public abstract boolean hasStripQuery()

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.

optional bool strip_query = 52284641;

Returns

Type	Description
boolean	Whether the stripQuery field is set.