Class HttpRedirectAction (1.57.0)

public final class HttpRedirectAction extends GeneratedMessageV3 implements HttpRedirectActionOrBuilder

Specifies settings for an HTTP redirect.

Protobuf type google.cloud.compute.v1.HttpRedirectAction

Static Fields

HOST_REDIRECT_FIELD_NUMBER

public static final int HOST_REDIRECT_FIELD_NUMBER
Field Value
Type Description
int

HTTPS_REDIRECT_FIELD_NUMBER

public static final int HTTPS_REDIRECT_FIELD_NUMBER
Field Value
Type Description
int

PATH_REDIRECT_FIELD_NUMBER

public static final int PATH_REDIRECT_FIELD_NUMBER
Field Value
Type Description
int

PREFIX_REDIRECT_FIELD_NUMBER

public static final int PREFIX_REDIRECT_FIELD_NUMBER
Field Value
Type Description
int

REDIRECT_RESPONSE_CODE_FIELD_NUMBER

public static final int REDIRECT_RESPONSE_CODE_FIELD_NUMBER
Field Value
Type Description
int

STRIP_QUERY_FIELD_NUMBER

public static final int STRIP_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpRedirectAction getDefaultInstance()
Returns
Type Description
HttpRedirectAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpRedirectAction.Builder newBuilder()
Returns
Type Description
HttpRedirectAction.Builder

newBuilder(HttpRedirectAction prototype)

public static HttpRedirectAction.Builder newBuilder(HttpRedirectAction prototype)
Parameter
Name Description
prototype HttpRedirectAction
Returns
Type Description
HttpRedirectAction.Builder

parseDelimitedFrom(InputStream input)

public static HttpRedirectAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpRedirectAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRedirectAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRedirectAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpRedirectAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpRedirectAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRedirectAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRedirectAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpRedirectAction> parser()
Returns
Type Description
Parser<HttpRedirectAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HttpRedirectAction getDefaultInstanceForType()
Returns
Type Description
HttpRedirectAction

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.

optional string host_redirect = 107417747;

Returns
Type Description
String

The hostRedirect.

getHostRedirectBytes()

public ByteString getHostRedirectBytes()

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.

optional string host_redirect = 107417747;

Returns
Type Description
ByteString

The bytes for hostRedirect.

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.

optional bool https_redirect = 170260656;

Returns
Type Description
boolean

The httpsRedirect.

getParserForType()

public Parser<HttpRedirectAction> getParserForType()
Returns
Type Description
Parser<HttpRedirectAction>
Overrides

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.

optional string path_redirect = 272342710;

Returns
Type Description
String

The pathRedirect.

getPathRedirectBytes()

public ByteString getPathRedirectBytes()

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.

optional string path_redirect = 272342710;

Returns
Type Description
ByteString

The bytes for pathRedirect.

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.

optional string prefix_redirect = 446184169;

Returns
Type Description
String

The prefixRedirect.

getPrefixRedirectBytes()

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

optional string prefix_redirect = 446184169;

Returns
Type Description
ByteString

The bytes for prefixRedirect.

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. Check the RedirectResponseCode enum for the list of possible values.

optional string redirect_response_code = 436710408;

Returns
Type Description
String

The redirectResponseCode.

getRedirectResponseCodeBytes()

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

optional string redirect_response_code = 436710408;

Returns
Type Description
ByteString

The bytes for redirectResponseCode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

optional bool strip_query = 52284641;

Returns
Type Description
boolean

The stripQuery.

hasHostRedirect()

public boolean hasHostRedirect()

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.

optional string host_redirect = 107417747;

Returns
Type Description
boolean

Whether the hostRedirect field is set.

hasHttpsRedirect()

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

optional bool https_redirect = 170260656;

Returns
Type Description
boolean

Whether the httpsRedirect field is set.

hasPathRedirect()

public boolean hasPathRedirect()

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.

optional string path_redirect = 272342710;

Returns
Type Description
boolean

Whether the pathRedirect field is set.

hasPrefixRedirect()

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

optional string prefix_redirect = 446184169;

Returns
Type Description
boolean

Whether the prefixRedirect field is set.

hasRedirectResponseCode()

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

optional string redirect_response_code = 436710408;

Returns
Type Description
boolean

Whether the redirectResponseCode field is set.

hasStripQuery()

public boolean hasStripQuery()

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.

optional bool strip_query = 52284641;

Returns
Type Description
boolean

Whether the stripQuery field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpRedirectAction.Builder newBuilderForType()
Returns
Type Description
HttpRedirectAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRedirectAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpRedirectAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpRedirectAction.Builder toBuilder()
Returns
Type Description
HttpRedirectAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException