com.google.api.services.compute.model

Class HttpRedirectAction

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.HttpRedirectAction

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HttpRedirectAction
extends com.google.api.client.json.GenericJson

Specifies settings for an HTTP redirect.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HttpRedirectAction()

Method Summary

Modifier and Type	Method and Description
HttpRedirectAction	clone()
String	getHostRedirect() The host that is used in the redirect response instead of the one that was supplied in the request.
Boolean	getHttpsRedirect() If set to true, the URL scheme in the redirected request is set to HTTPS.
String	getPathRedirect() The path that is used in the redirect response instead of the one that was supplied in the request.
String	getPrefixRedirect() The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
String	getRedirectResponseCode() The HTTP Status code to use for this RedirectAction.
Boolean	getStripQuery() If set to true, any accompanying query portion of the original URL is removed before redirecting the request.
HttpRedirectAction	set(String fieldName, Object value)
HttpRedirectAction	setHostRedirect(String hostRedirect) The host that is used in the redirect response instead of the one that was supplied in the request.
HttpRedirectAction	setHttpsRedirect(Boolean httpsRedirect) If set to true, the URL scheme in the redirected request is set to HTTPS.
HttpRedirectAction	setPathRedirect(String pathRedirect) The path that is used in the redirect response instead of the one that was supplied in the request.
HttpRedirectAction	setPrefixRedirect(String prefixRedirect) The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
HttpRedirectAction	setRedirectResponseCode(String redirectResponseCode) The HTTP Status code to use for this RedirectAction.
HttpRedirectAction	setStripQuery(Boolean stripQuery) If set to true, any accompanying query portion of the original URL is removed before redirecting the request.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

HttpRedirectAction

public HttpRedirectAction()

Method Detail

getHostRedirect

public String 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:

value or null for none

setHostRedirect

public HttpRedirectAction setHostRedirect(String hostRedirect)

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.

Parameters:

hostRedirect - hostRedirect or null for none

getHttpsRedirect

public 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 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:

value or null for none

setHttpsRedirect

public HttpRedirectAction setHttpsRedirect(Boolean httpsRedirect)

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.

Parameters:

httpsRedirect - httpsRedirect or null for none

getPathRedirect

public String 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:

value or null for none

setPathRedirect

public HttpRedirectAction setPathRedirect(String pathRedirect)

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.

Parameters:

pathRedirect - pathRedirect or null for none

getPrefixRedirect

public 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 is used for the redirect. The value must be from 1 to 1024 characters.

Returns:

value or null for none

setPrefixRedirect

public HttpRedirectAction setPrefixRedirect(String prefixRedirect)

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.

Parameters:

prefixRedirect - prefixRedirect or null for none

getRedirectResponseCode

public 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 is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.

Returns:

value or null for none

setRedirectResponseCode

public HttpRedirectAction setRedirectResponseCode(String redirectResponseCode)

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.

Parameters:

redirectResponseCode - redirectResponseCode or null for none

getStripQuery

public Boolean 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:

value or null for none

setStripQuery

public HttpRedirectAction setStripQuery(Boolean stripQuery)

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.

Parameters:

stripQuery - stripQuery or null for none

set

public HttpRedirectAction set(String fieldName,
                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public HttpRedirectAction clone()

Overrides:

clone in class com.google.api.client.json.GenericJson