Package io.envoyproxy.envoy.api.v2.route

Class RedirectAction.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedirectActionOrBuilder, Cloneable
    Enclosing class:
    RedirectAction
    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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • clear

        public RedirectAction.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • getDefaultInstanceForType

        public RedirectAction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public RedirectAction build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public RedirectAction buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public RedirectAction.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • setField

        public RedirectAction.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • clearField

        public RedirectAction.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • clearOneof

        public RedirectAction.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • setRepeatedField

        public RedirectAction.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • addRepeatedField

        public RedirectAction.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • mergeFrom

        public RedirectAction.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedirectAction.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • mergeFrom

        public RedirectAction.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedirectAction.Builder>
        Throws:
        IOException

      • hasHttpsRedirect

        public boolean hasHttpsRedirect()
         The scheme portion of the URL will be swapped with "https".
        bool https_redirect = 4;
        Specified by:
        hasHttpsRedirect in interface RedirectActionOrBuilder
        Returns:
        Whether the httpsRedirect field is set.

      • getHttpsRedirect

        public boolean getHttpsRedirect()
         The scheme portion of the URL will be swapped with "https".
        bool https_redirect = 4;
        Specified by:
        getHttpsRedirect in interface RedirectActionOrBuilder
        Returns:
        The httpsRedirect.

      • setHttpsRedirect

        public RedirectAction.Builder setHttpsRedirect​(boolean value)
         The scheme portion of the URL will be swapped with "https".
        bool https_redirect = 4;
        Parameters:
        value - The httpsRedirect to set.
        Returns:
        This builder for chaining.

      • clearHttpsRedirect

        public RedirectAction.Builder clearHttpsRedirect()
         The scheme portion of the URL will be swapped with "https".
        bool https_redirect = 4;
        Returns:
        This builder for chaining.

      • hasSchemeRedirect

        public boolean hasSchemeRedirect()
         The scheme portion of the URL will be swapped with this value.
        string scheme_redirect = 7;
        Specified by:
        hasSchemeRedirect in interface RedirectActionOrBuilder
        Returns:
        Whether the schemeRedirect field is set.

      • getSchemeRedirect

        public String getSchemeRedirect()
         The scheme portion of the URL will be swapped with this value.
        string scheme_redirect = 7;
        Specified by:
        getSchemeRedirect in interface RedirectActionOrBuilder
        Returns:
        The schemeRedirect.

      • getSchemeRedirectBytes

        public com.google.protobuf.ByteString getSchemeRedirectBytes()
         The scheme portion of the URL will be swapped with this value.
        string scheme_redirect = 7;
        Specified by:
        getSchemeRedirectBytes in interface RedirectActionOrBuilder
        Returns:
        The bytes for schemeRedirect.

      • setSchemeRedirect

        public RedirectAction.Builder setSchemeRedirect​(String value)
         The scheme portion of the URL will be swapped with this value.
        string scheme_redirect = 7;
        Parameters:
        value - The schemeRedirect to set.
        Returns:
        This builder for chaining.

      • clearSchemeRedirect

        public RedirectAction.Builder clearSchemeRedirect()
         The scheme portion of the URL will be swapped with this value.
        string scheme_redirect = 7;
        Returns:
        This builder for chaining.

      • setSchemeRedirectBytes

        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;
        Parameters:
        value - The bytes for schemeRedirect to set.
        Returns:
        This builder for chaining.

      • getHostRedirect

        public String getHostRedirect()
         The host portion of the URL will be swapped with this value.
        string host_redirect = 1 [(.validate.rules) = { ... }
        Specified by:
        getHostRedirect in interface RedirectActionOrBuilder
        Returns:
        The hostRedirect.

      • getHostRedirectBytes

        public com.google.protobuf.ByteString getHostRedirectBytes()
         The host portion of the URL will be swapped with this value.
        string host_redirect = 1 [(.validate.rules) = { ... }
        Specified by:
        getHostRedirectBytes in interface RedirectActionOrBuilder
        Returns:
        The bytes for hostRedirect.

      • setHostRedirect

        public RedirectAction.Builder setHostRedirect​(String value)
         The host portion of the URL will be swapped with this value.
        string host_redirect = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The hostRedirect to set.
        Returns:
        This builder for chaining.

      • clearHostRedirect

        public RedirectAction.Builder clearHostRedirect()
         The host portion of the URL will be swapped with this value.
        string host_redirect = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setHostRedirectBytes

        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) = { ... }
        Parameters:
        value - The bytes for hostRedirect to set.
        Returns:
        This builder for chaining.

      • getPortRedirect

        public int getPortRedirect()
         The port value of the URL will be swapped with this value.
        uint32 port_redirect = 8;
        Specified by:
        getPortRedirect in interface RedirectActionOrBuilder
        Returns:
        The portRedirect.

      • setPortRedirect

        public RedirectAction.Builder setPortRedirect​(int value)
         The port value of the URL will be swapped with this value.
        uint32 port_redirect = 8;
        Parameters:
        value - The portRedirect to set.
        Returns:
        This builder for chaining.

      • clearPortRedirect

        public RedirectAction.Builder clearPortRedirect()
         The port value of the URL will be swapped with this value.
        uint32 port_redirect = 8;
        Returns:
        This builder for chaining.

      • hasPathRedirect

        public boolean hasPathRedirect()
         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) = { ... }
        Specified by:
        hasPathRedirect in interface RedirectActionOrBuilder
        Returns:
        Whether the pathRedirect field is set.

      • getPathRedirect

        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) = { ... }
        Specified by:
        getPathRedirect in interface RedirectActionOrBuilder
        Returns:
        The pathRedirect.

      • getPathRedirectBytes

        public 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) = { ... }
        Specified by:
        getPathRedirectBytes in interface RedirectActionOrBuilder
        Returns:
        The bytes for pathRedirect.

      • setPathRedirect

        public 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) = { ... }
        Parameters:
        value - The pathRedirect to set.
        Returns:
        This builder for chaining.

      • clearPathRedirect

        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) = { ... }
        Returns:
        This builder for chaining.

      • setPathRedirectBytes

        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) = { ... }
        Parameters:
        value - The bytes for pathRedirect to set.
        Returns:
        This builder for chaining.

      • hasPrefixRewrite

        public boolean hasPrefixRewrite()
         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) = { ... }
        Specified by:
        hasPrefixRewrite in interface RedirectActionOrBuilder
        Returns:
        Whether the prefixRewrite field is set.

      • getPrefixRewrite

        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) = { ... }
        Specified by:
        getPrefixRewrite in interface RedirectActionOrBuilder
        Returns:
        The prefixRewrite.

      • getPrefixRewriteBytes

        public 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) = { ... }
        Specified by:
        getPrefixRewriteBytes in interface RedirectActionOrBuilder
        Returns:
        The bytes for prefixRewrite.

      • setPrefixRewrite

        public 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) = { ... }
        Parameters:
        value - The prefixRewrite to set.
        Returns:
        This builder for chaining.

      • clearPrefixRewrite

        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) = { ... }
        Returns:
        This builder for chaining.

      • setPrefixRewriteBytes

        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) = { ... }
        Parameters:
        value - The bytes for prefixRewrite to set.
        Returns:
        This builder for chaining.

      • getResponseCodeValue

        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) = { ... }
        Specified by:
        getResponseCodeValue in interface RedirectActionOrBuilder
        Returns:
        The enum numeric value on the wire for responseCode.

      • setResponseCodeValue

        public 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) = { ... }
        Parameters:
        value - The enum numeric value on the wire for responseCode to set.
        Returns:
        This builder for chaining.

      • getResponseCode

        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) = { ... }
        Specified by:
        getResponseCode in interface RedirectActionOrBuilder
        Returns:
        The responseCode.

      • setResponseCode

        public 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) = { ... }
        Parameters:
        value - The responseCode to set.
        Returns:
        This builder for chaining.

      • clearResponseCode

        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) = { ... }
        Returns:
        This builder for chaining.

      • getStripQuery

        public boolean getStripQuery()
         Indicates that during redirection, the query portion of the URL will
 be removed. Default value is false.
        bool strip_query = 6;
        Specified by:
        getStripQuery in interface RedirectActionOrBuilder
        Returns:
        The stripQuery.

      • setStripQuery

        public 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;
        Parameters:
        value - The stripQuery to set.
        Returns:
        This builder for chaining.

      • clearStripQuery

        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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final RedirectAction.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>

      • mergeUnknownFields

        public final RedirectAction.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedirectAction.Builder>