Class HttpRedirectAction (1.54.0)

Version 1.54.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 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 final class HttpRedirectAction extends GeneratedMessageV3 implements HttpRedirectActionOrBuilder

Specifies settings for an HTTP redirect.

Protobuf type google.cloud.compute.v1.HttpRedirectAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpRedirectAction

Implements

HttpRedirectActionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public HttpRedirectAction.Builder toBuilder()

Returns
Type	Description
HttpRedirectAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException