Interface HttpRoute.RedirectOrBuilder (0.5.0)

public static interface HttpRoute.RedirectOrBuilder 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.

string host_redirect = 1;

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.

string host_redirect = 1;

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.

The default is set to false.

bool https_redirect = 5;

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

string path_redirect = 2;

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

string path_redirect = 2;

Returns
Type Description
ByteString

The bytes for pathRedirect.

getPortRedirect()

public abstract int getPortRedirect()

The port that will be used in the redirected request instead of the one that was supplied in the request.

int32 port_redirect = 7;

Returns
Type Description
int

The portRedirect.

getPrefixRewrite()

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

string prefix_rewrite = 3;

Returns
Type Description
String

The prefixRewrite.

getPrefixRewriteBytes()

public abstract ByteString getPrefixRewriteBytes()

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.

string prefix_rewrite = 3;

Returns
Type Description
ByteString

The bytes for prefixRewrite.

getResponseCode()

public abstract HttpRoute.Redirect.ResponseCode getResponseCode()

The HTTP Status code to use for the redirect.

.google.cloud.networkservices.v1.HttpRoute.Redirect.ResponseCode response_code = 4;

Returns
Type Description
HttpRoute.Redirect.ResponseCode

The responseCode.

getResponseCodeValue()

public abstract int getResponseCodeValue()

The HTTP Status code to use for the redirect.

.google.cloud.networkservices.v1.HttpRoute.Redirect.ResponseCode response_code = 4;

Returns
Type Description
int

The enum numeric value on the wire for responseCode.

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.

bool strip_query = 6;

Returns
Type Description
boolean

The stripQuery.