Package io.envoyproxy.envoy.config.route.v3

Class InternalRedirectPolicy.Builder

    • 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<InternalRedirectPolicy.Builder>

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

        public InternalRedirectPolicy.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<InternalRedirectPolicy.Builder>
        Throws:
        IOException

      • hasMaxInternalRedirects

        public boolean hasMaxInternalRedirects()
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;
        Specified by:
        hasMaxInternalRedirects in interface InternalRedirectPolicyOrBuilder
        Returns:
        Whether the maxInternalRedirects field is set.

      • getMaxInternalRedirects

        public com.google.protobuf.UInt32Value getMaxInternalRedirects()
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;
        Specified by:
        getMaxInternalRedirects in interface InternalRedirectPolicyOrBuilder
        Returns:
        The maxInternalRedirects.

      • setMaxInternalRedirects

        public InternalRedirectPolicy.Builder setMaxInternalRedirects​(com.google.protobuf.UInt32Value value)
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;

      • setMaxInternalRedirects

        public InternalRedirectPolicy.Builder setMaxInternalRedirects​(com.google.protobuf.UInt32Value.Builder builderForValue)
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;

      • mergeMaxInternalRedirects

        public InternalRedirectPolicy.Builder mergeMaxInternalRedirects​(com.google.protobuf.UInt32Value value)
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;

      • clearMaxInternalRedirects

        public InternalRedirectPolicy.Builder clearMaxInternalRedirects()
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;

      • getMaxInternalRedirectsBuilder

        public com.google.protobuf.UInt32Value.Builder getMaxInternalRedirectsBuilder()
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;

      • getMaxInternalRedirectsOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getMaxInternalRedirectsOrBuilder()
         An internal redirect is not handled, unless the number of previous internal redirects that a
 downstream request has encountered is lower than this value.
 In the case where a downstream request is bounced among multiple routes by internal redirect,
 the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
 <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
 will pass the redirect back to downstream.
 If not specified, at most one redirect will be followed.
        .google.protobuf.UInt32Value max_internal_redirects = 1;
        Specified by:
        getMaxInternalRedirectsOrBuilder in interface InternalRedirectPolicyOrBuilder

      • getRedirectResponseCodesList

        public List<Integer> getRedirectResponseCodesList()
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Specified by:
        getRedirectResponseCodesList in interface InternalRedirectPolicyOrBuilder
        Returns:
        A list containing the redirectResponseCodes.

      • getRedirectResponseCodesCount

        public int getRedirectResponseCodesCount()
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Specified by:
        getRedirectResponseCodesCount in interface InternalRedirectPolicyOrBuilder
        Returns:
        The count of redirectResponseCodes.

      • getRedirectResponseCodes

        public int getRedirectResponseCodes​(int index)
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Specified by:
        getRedirectResponseCodes in interface InternalRedirectPolicyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The redirectResponseCodes at the given index.

      • setRedirectResponseCodes

        public InternalRedirectPolicy.Builder setRedirectResponseCodes​(int index,
                                                               int value)
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Parameters:
        index - The index to set the value at.
        value - The redirectResponseCodes to set.
        Returns:
        This builder for chaining.

      • addRedirectResponseCodes

        public InternalRedirectPolicy.Builder addRedirectResponseCodes​(int value)
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The redirectResponseCodes to add.
        Returns:
        This builder for chaining.

      • addAllRedirectResponseCodes

        public InternalRedirectPolicy.Builder addAllRedirectResponseCodes​(Iterable<? extends Integer> values)
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Parameters:
        values - The redirectResponseCodes to add.
        Returns:
        This builder for chaining.

      • clearRedirectResponseCodes

        public InternalRedirectPolicy.Builder clearRedirectResponseCodes()
         Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
 only 302 will be treated as internal redirect.
 Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
        repeated uint32 redirect_response_codes = 2 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • getPredicatesList

        public List<TypedExtensionConfig> getPredicatesList()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;
        Specified by:
        getPredicatesList in interface InternalRedirectPolicyOrBuilder

      • getPredicatesCount

        public int getPredicatesCount()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;
        Specified by:
        getPredicatesCount in interface InternalRedirectPolicyOrBuilder

      • getPredicates

        public TypedExtensionConfig getPredicates​(int index)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;
        Specified by:
        getPredicates in interface InternalRedirectPolicyOrBuilder

      • setPredicates

        public InternalRedirectPolicy.Builder setPredicates​(int index,
                                                    TypedExtensionConfig value)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • setPredicates

        public InternalRedirectPolicy.Builder setPredicates​(int index,
                                                    TypedExtensionConfig.Builder builderForValue)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addPredicates

        public InternalRedirectPolicy.Builder addPredicates​(TypedExtensionConfig value)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addPredicates

        public InternalRedirectPolicy.Builder addPredicates​(int index,
                                                    TypedExtensionConfig value)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addPredicates

        public InternalRedirectPolicy.Builder addPredicates​(TypedExtensionConfig.Builder builderForValue)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addPredicates

        public InternalRedirectPolicy.Builder addPredicates​(int index,
                                                    TypedExtensionConfig.Builder builderForValue)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addAllPredicates

        public InternalRedirectPolicy.Builder addAllPredicates​(Iterable<? extends TypedExtensionConfig> values)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • clearPredicates

        public InternalRedirectPolicy.Builder clearPredicates()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • removePredicates

        public InternalRedirectPolicy.Builder removePredicates​(int index)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • getPredicatesBuilder

        public TypedExtensionConfig.Builder getPredicatesBuilder​(int index)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • getPredicatesOrBuilder

        public TypedExtensionConfigOrBuilder getPredicatesOrBuilder​(int index)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;
        Specified by:
        getPredicatesOrBuilder in interface InternalRedirectPolicyOrBuilder

      • getPredicatesOrBuilderList

        public List<? extends TypedExtensionConfigOrBuilder> getPredicatesOrBuilderList()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;
        Specified by:
        getPredicatesOrBuilderList in interface InternalRedirectPolicyOrBuilder

      • addPredicatesBuilder

        public TypedExtensionConfig.Builder addPredicatesBuilder()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • addPredicatesBuilder

        public TypedExtensionConfig.Builder addPredicatesBuilder​(int index)
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • getPredicatesBuilderList

        public List<TypedExtensionConfig.Builder> getPredicatesBuilderList()
         Specifies a list of predicates that are queried when an upstream response is deemed
 to trigger an internal redirect by all other criteria. Any predicate in the list can reject
 the redirect, causing the response to be proxied to downstream.
 [#extension-category: envoy.internal_redirect_predicates]
        repeated .envoy.config.core.v3.TypedExtensionConfig predicates = 3;

      • getAllowCrossSchemeRedirect

        public boolean getAllowCrossSchemeRedirect()
         Allow internal redirect to follow a target URI with a different scheme than the value of
 x-forwarded-proto. The default is false.
        bool allow_cross_scheme_redirect = 4;
        Specified by:
        getAllowCrossSchemeRedirect in interface InternalRedirectPolicyOrBuilder
        Returns:
        The allowCrossSchemeRedirect.

      • setAllowCrossSchemeRedirect

        public InternalRedirectPolicy.Builder setAllowCrossSchemeRedirect​(boolean value)
         Allow internal redirect to follow a target URI with a different scheme than the value of
 x-forwarded-proto. The default is false.
        bool allow_cross_scheme_redirect = 4;
        Parameters:
        value - The allowCrossSchemeRedirect to set.
        Returns:
        This builder for chaining.

      • clearAllowCrossSchemeRedirect

        public InternalRedirectPolicy.Builder clearAllowCrossSchemeRedirect()
         Allow internal redirect to follow a target URI with a different scheme than the value of
 x-forwarded-proto. The default is false.
        bool allow_cross_scheme_redirect = 4;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final InternalRedirectPolicy.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<InternalRedirectPolicy.Builder>

      • mergeUnknownFields

        public final InternalRedirectPolicy.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<InternalRedirectPolicy.Builder>