Class HttpRedirectAction.Builder (1.32.0)

public static final class HttpRedirectAction.Builder extends GeneratedMessageV3.Builder<HttpRedirectAction.Builder> implements HttpRedirectActionOrBuilder

Specifies settings for an HTTP redirect.

Protobuf type google.cloud.compute.v1.HttpRedirectAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpRedirectAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

build()

public HttpRedirectAction build()
Returns
TypeDescription
HttpRedirectAction

buildPartial()

public HttpRedirectAction buildPartial()
Returns
TypeDescription
HttpRedirectAction

clear()

public HttpRedirectAction.Builder clear()
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public HttpRedirectAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

clearHostRedirect()

public HttpRedirectAction.Builder clearHostRedirect()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clearHttpsRedirect()

public HttpRedirectAction.Builder clearHttpsRedirect()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpRedirectAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

clearPathRedirect()

public HttpRedirectAction.Builder clearPathRedirect()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clearPrefixRedirect()

public HttpRedirectAction.Builder clearPrefixRedirect()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clearRedirectResponseCode()

public HttpRedirectAction.Builder clearRedirectResponseCode()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clearStripQuery()

public HttpRedirectAction.Builder clearStripQuery()

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
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

clone()

public HttpRedirectAction.Builder clone()
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

getDefaultInstanceForType()

public HttpRedirectAction getDefaultInstanceForType()
Returns
TypeDescription
HttpRedirectAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The httpsRedirect.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for redirectResponseCode.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the stripQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(HttpRedirectAction other)

public HttpRedirectAction.Builder mergeFrom(HttpRedirectAction other)
Parameter
NameDescription
otherHttpRedirectAction
Returns
TypeDescription
HttpRedirectAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpRedirectAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public HttpRedirectAction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpRedirectAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public HttpRedirectAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

setHostRedirect(String value)

public HttpRedirectAction.Builder setHostRedirect(String value)

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;

Parameter
NameDescription
valueString

The hostRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setHostRedirectBytes(ByteString value)

public HttpRedirectAction.Builder setHostRedirectBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for hostRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setHttpsRedirect(boolean value)

public HttpRedirectAction.Builder setHttpsRedirect(boolean value)

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;

Parameter
NameDescription
valueboolean

The httpsRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setPathRedirect(String value)

public HttpRedirectAction.Builder setPathRedirect(String value)

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;

Parameter
NameDescription
valueString

The pathRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setPathRedirectBytes(ByteString value)

public HttpRedirectAction.Builder setPathRedirectBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for pathRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setPrefixRedirect(String value)

public HttpRedirectAction.Builder setPrefixRedirect(String value)

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;

Parameter
NameDescription
valueString

The prefixRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setPrefixRedirectBytes(ByteString value)

public HttpRedirectAction.Builder setPrefixRedirectBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for prefixRedirect to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setRedirectResponseCode(String value)

public HttpRedirectAction.Builder setRedirectResponseCode(String value)

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;

Parameter
NameDescription
valueString

The redirectResponseCode to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setRedirectResponseCodeBytes(ByteString value)

public HttpRedirectAction.Builder setRedirectResponseCodeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for redirectResponseCode to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HttpRedirectAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides

setStripQuery(boolean value)

public HttpRedirectAction.Builder setStripQuery(boolean value)

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;

Parameter
NameDescription
valueboolean

The stripQuery to set.

Returns
TypeDescription
HttpRedirectAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpRedirectAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
HttpRedirectAction.Builder
Overrides