public static final class RedirectAction.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder> implements RedirectActionOrBuilder
[#next-free-field: 9]Protobuf type
envoy.api.v2.route.RedirectAction| Modifier and Type | Method and Description |
|---|---|
RedirectAction.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RedirectAction |
build() |
RedirectAction |
buildPartial() |
RedirectAction.Builder |
clear() |
RedirectAction.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RedirectAction.Builder |
clearHostRedirect()
The host portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
clearHttpsRedirect()
The scheme portion of the URL will be swapped with "https".
|
RedirectAction.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RedirectAction.Builder |
clearPathRedirect()
The path portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
clearPathRewriteSpecifier() |
RedirectAction.Builder |
clearPortRedirect()
The port value of the URL will be swapped with this value.
|
RedirectAction.Builder |
clearPrefixRewrite()
Indicates that during redirection, the matched prefix (or path)
should be swapped with this value.
|
RedirectAction.Builder |
clearResponseCode()
The HTTP status code to use in the redirect response.
|
RedirectAction.Builder |
clearSchemeRedirect()
The scheme portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
clearSchemeRewriteSpecifier() |
RedirectAction.Builder |
clearStripQuery()
Indicates that during redirection, the query portion of the URL will
be removed.
|
RedirectAction.Builder |
clone() |
RedirectAction |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getHostRedirect()
The host portion of the URL will be swapped with this value.
|
com.google.protobuf.ByteString |
getHostRedirectBytes()
The host portion of the URL will be swapped with this value.
|
boolean |
getHttpsRedirect()
The scheme portion of the URL will be swapped with "https".
|
String |
getPathRedirect()
The path portion of the URL will be swapped with this value.
|
com.google.protobuf.ByteString |
getPathRedirectBytes()
The path portion of the URL will be swapped with this value.
|
RedirectAction.PathRewriteSpecifierCase |
getPathRewriteSpecifierCase() |
int |
getPortRedirect()
The port value of the URL will be swapped with this value.
|
String |
getPrefixRewrite()
Indicates that during redirection, the matched prefix (or path)
should be swapped with this value.
|
com.google.protobuf.ByteString |
getPrefixRewriteBytes()
Indicates that during redirection, the matched prefix (or path)
should be swapped with this value.
|
RedirectAction.RedirectResponseCode |
getResponseCode()
The HTTP status code to use in the redirect response.
|
int |
getResponseCodeValue()
The HTTP status code to use in the redirect response.
|
String |
getSchemeRedirect()
The scheme portion of the URL will be swapped with this value.
|
com.google.protobuf.ByteString |
getSchemeRedirectBytes()
The scheme portion of the URL will be swapped with this value.
|
RedirectAction.SchemeRewriteSpecifierCase |
getSchemeRewriteSpecifierCase() |
boolean |
getStripQuery()
Indicates that during redirection, the query portion of the URL will
be removed.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RedirectAction.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RedirectAction.Builder |
mergeFrom(com.google.protobuf.Message other) |
RedirectAction.Builder |
mergeFrom(RedirectAction other) |
RedirectAction.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RedirectAction.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RedirectAction.Builder |
setHostRedirect(String value)
The host portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setHostRedirectBytes(com.google.protobuf.ByteString value)
The host portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setHttpsRedirect(boolean value)
The scheme portion of the URL will be swapped with "https".
|
RedirectAction.Builder |
setPathRedirect(String value)
The path portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setPathRedirectBytes(com.google.protobuf.ByteString value)
The path portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setPortRedirect(int value)
The port value of the URL will be swapped with this value.
|
RedirectAction.Builder |
setPrefixRewrite(String value)
Indicates that during redirection, the matched prefix (or path)
should be swapped with this value.
|
RedirectAction.Builder |
setPrefixRewriteBytes(com.google.protobuf.ByteString value)
Indicates that during redirection, the matched prefix (or path)
should be swapped with this value.
|
RedirectAction.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RedirectAction.Builder |
setResponseCode(RedirectAction.RedirectResponseCode value)
The HTTP status code to use in the redirect response.
|
RedirectAction.Builder |
setResponseCodeValue(int value)
The HTTP status code to use in the redirect response.
|
RedirectAction.Builder |
setSchemeRedirect(String value)
The scheme portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setSchemeRedirectBytes(com.google.protobuf.ByteString value)
The scheme portion of the URL will be swapped with this value.
|
RedirectAction.Builder |
setStripQuery(boolean value)
Indicates that during redirection, the query portion of the URL will
be removed.
|
RedirectAction.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RedirectAction build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RedirectAction buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RedirectAction.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedirectAction.Builder>public RedirectAction.Builder mergeFrom(RedirectAction other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public RedirectAction.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedirectAction.Builder>IOExceptionpublic RedirectAction.SchemeRewriteSpecifierCase getSchemeRewriteSpecifierCase()
getSchemeRewriteSpecifierCase in interface RedirectActionOrBuilderpublic RedirectAction.Builder clearSchemeRewriteSpecifier()
public RedirectAction.PathRewriteSpecifierCase getPathRewriteSpecifierCase()
getPathRewriteSpecifierCase in interface RedirectActionOrBuilderpublic RedirectAction.Builder clearPathRewriteSpecifier()
public boolean getHttpsRedirect()
The scheme portion of the URL will be swapped with "https".
bool https_redirect = 4;getHttpsRedirect in interface RedirectActionOrBuilderpublic RedirectAction.Builder setHttpsRedirect(boolean value)
The scheme portion of the URL will be swapped with "https".
bool https_redirect = 4;public RedirectAction.Builder clearHttpsRedirect()
The scheme portion of the URL will be swapped with "https".
bool https_redirect = 4;public String getSchemeRedirect()
The scheme portion of the URL will be swapped with this value.
string scheme_redirect = 7;getSchemeRedirect in interface RedirectActionOrBuilderpublic com.google.protobuf.ByteString getSchemeRedirectBytes()
The scheme portion of the URL will be swapped with this value.
string scheme_redirect = 7;getSchemeRedirectBytes in interface RedirectActionOrBuilderpublic RedirectAction.Builder setSchemeRedirect(String value)
The scheme portion of the URL will be swapped with this value.
string scheme_redirect = 7;public RedirectAction.Builder clearSchemeRedirect()
The scheme portion of the URL will be swapped with this value.
string scheme_redirect = 7;public RedirectAction.Builder setSchemeRedirectBytes(com.google.protobuf.ByteString value)
The scheme portion of the URL will be swapped with this value.
string scheme_redirect = 7;public String getHostRedirect()
The host portion of the URL will be swapped with this value.
string host_redirect = 1 [(.validate.rules) = { ... }getHostRedirect in interface RedirectActionOrBuilderpublic com.google.protobuf.ByteString getHostRedirectBytes()
The host portion of the URL will be swapped with this value.
string host_redirect = 1 [(.validate.rules) = { ... }getHostRedirectBytes in interface RedirectActionOrBuilderpublic RedirectAction.Builder setHostRedirect(String value)
The host portion of the URL will be swapped with this value.
string host_redirect = 1 [(.validate.rules) = { ... }public RedirectAction.Builder clearHostRedirect()
The host portion of the URL will be swapped with this value.
string host_redirect = 1 [(.validate.rules) = { ... }public RedirectAction.Builder setHostRedirectBytes(com.google.protobuf.ByteString value)
The host portion of the URL will be swapped with this value.
string host_redirect = 1 [(.validate.rules) = { ... }public int getPortRedirect()
The port value of the URL will be swapped with this value.
uint32 port_redirect = 8;getPortRedirect in interface RedirectActionOrBuilderpublic RedirectAction.Builder setPortRedirect(int value)
The port value of the URL will be swapped with this value.
uint32 port_redirect = 8;public RedirectAction.Builder clearPortRedirect()
The port value of the URL will be swapped with this value.
uint32 port_redirect = 8;public String getPathRedirect()
The path portion of the URL will be swapped with this value.
Please note that query string in path_redirect will override the
request's query string and will not be stripped.
For example, let's say we have the following routes:
- match: { path: "/old-path-1" }
redirect: { path_redirect: "/new-path-1" }
- match: { path: "/old-path-2" }
redirect: { path_redirect: "/new-path-2", strip-query: "true" }
- match: { path: "/old-path-3" }
redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string path_redirect = 2 [(.validate.rules) = { ... }getPathRedirect in interface RedirectActionOrBuilderpublic com.google.protobuf.ByteString getPathRedirectBytes()
The path portion of the URL will be swapped with this value.
Please note that query string in path_redirect will override the
request's query string and will not be stripped.
For example, let's say we have the following routes:
- match: { path: "/old-path-1" }
redirect: { path_redirect: "/new-path-1" }
- match: { path: "/old-path-2" }
redirect: { path_redirect: "/new-path-2", strip-query: "true" }
- match: { path: "/old-path-3" }
redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string path_redirect = 2 [(.validate.rules) = { ... }getPathRedirectBytes in interface RedirectActionOrBuilderpublic RedirectAction.Builder setPathRedirect(String value)
The path portion of the URL will be swapped with this value.
Please note that query string in path_redirect will override the
request's query string and will not be stripped.
For example, let's say we have the following routes:
- match: { path: "/old-path-1" }
redirect: { path_redirect: "/new-path-1" }
- match: { path: "/old-path-2" }
redirect: { path_redirect: "/new-path-2", strip-query: "true" }
- match: { path: "/old-path-3" }
redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string path_redirect = 2 [(.validate.rules) = { ... }public RedirectAction.Builder clearPathRedirect()
The path portion of the URL will be swapped with this value.
Please note that query string in path_redirect will override the
request's query string and will not be stripped.
For example, let's say we have the following routes:
- match: { path: "/old-path-1" }
redirect: { path_redirect: "/new-path-1" }
- match: { path: "/old-path-2" }
redirect: { path_redirect: "/new-path-2", strip-query: "true" }
- match: { path: "/old-path-3" }
redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string path_redirect = 2 [(.validate.rules) = { ... }public RedirectAction.Builder setPathRedirectBytes(com.google.protobuf.ByteString value)
The path portion of the URL will be swapped with this value.
Please note that query string in path_redirect will override the
request's query string and will not be stripped.
For example, let's say we have the following routes:
- match: { path: "/old-path-1" }
redirect: { path_redirect: "/new-path-1" }
- match: { path: "/old-path-2" }
redirect: { path_redirect: "/new-path-2", strip-query: "true" }
- match: { path: "/old-path-3" }
redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string path_redirect = 2 [(.validate.rules) = { ... }public String getPrefixRewrite()
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request. .. attention:: Pay attention to the use of trailing slashes as mentioned in :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.
string prefix_rewrite = 5 [(.validate.rules) = { ... }getPrefixRewrite in interface RedirectActionOrBuilderpublic com.google.protobuf.ByteString getPrefixRewriteBytes()
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request. .. attention:: Pay attention to the use of trailing slashes as mentioned in :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.
string prefix_rewrite = 5 [(.validate.rules) = { ... }getPrefixRewriteBytes in interface RedirectActionOrBuilderpublic RedirectAction.Builder setPrefixRewrite(String value)
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request. .. attention:: Pay attention to the use of trailing slashes as mentioned in :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.
string prefix_rewrite = 5 [(.validate.rules) = { ... }public RedirectAction.Builder clearPrefixRewrite()
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request. .. attention:: Pay attention to the use of trailing slashes as mentioned in :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.
string prefix_rewrite = 5 [(.validate.rules) = { ... }public RedirectAction.Builder setPrefixRewriteBytes(com.google.protobuf.ByteString value)
Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request. .. attention:: Pay attention to the use of trailing slashes as mentioned in :ref:`RouteAction's prefix_rewrite <envoy_api_field_route.RouteAction.prefix_rewrite>`.
string prefix_rewrite = 5 [(.validate.rules) = { ... }public int getResponseCodeValue()
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }getResponseCodeValue in interface RedirectActionOrBuilderpublic RedirectAction.Builder setResponseCodeValue(int value)
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }public RedirectAction.RedirectResponseCode getResponseCode()
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }getResponseCode in interface RedirectActionOrBuilderpublic RedirectAction.Builder setResponseCode(RedirectAction.RedirectResponseCode value)
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }public RedirectAction.Builder clearResponseCode()
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
.envoy.api.v2.route.RedirectAction.RedirectResponseCode response_code = 3 [(.validate.rules) = { ... }public boolean getStripQuery()
Indicates that during redirection, the query portion of the URL will be removed. Default value is false.
bool strip_query = 6;getStripQuery in interface RedirectActionOrBuilderpublic RedirectAction.Builder setStripQuery(boolean value)
Indicates that during redirection, the query portion of the URL will be removed. Default value is false.
bool strip_query = 6;public RedirectAction.Builder clearStripQuery()
Indicates that during redirection, the query portion of the URL will be removed. Default value is false.
bool strip_query = 6;public final RedirectAction.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>public final RedirectAction.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.