Interface InternalRedirectPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
InternalRedirectPolicy, InternalRedirectPolicy.Builder

public interface InternalRedirectPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Allow internal redirect to follow a target URI with a different scheme than the value of x-forwarded-proto.
    com.google.protobuf.UInt32Value
    An internal redirect is not handled, unless the number of previous internal redirects that a downstream request has encountered is lower than this value.
    com.google.protobuf.UInt32ValueOrBuilder
    An internal redirect is not handled, unless the number of previous internal redirects that a downstream request has encountered is lower than this value.
    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.
    int
    Specifies a list of predicates that are queried when an upstream response is deemed to trigger an internal redirect by all other criteria.
    Specifies a list of predicates that are queried when an upstream response is deemed to trigger an internal redirect by all other criteria.
    Specifies a list of predicates that are queried when an upstream response is deemed to trigger an internal redirect by all other criteria.
    Specifies a list of predicates that are queried when an upstream response is deemed to trigger an internal redirect by all other criteria.
    int
    Defines what upstream response codes are allowed to trigger internal redirect.
    int
    Defines what upstream response codes are allowed to trigger internal redirect.
    Defines what upstream response codes are allowed to trigger internal redirect.
    Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.
    com.google.protobuf.ByteString
    Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.
    int
    Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.
    Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.
    boolean
    An internal redirect is not handled, unless the number of previous internal redirects that a downstream request has encountered is lower than this value.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasMaxInternalRedirects

      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;
      Returns:
      Whether the maxInternalRedirects field is set.
    • getMaxInternalRedirects

      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;
      Returns:
      The maxInternalRedirects.
    • getMaxInternalRedirectsOrBuilder

      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;
    • getRedirectResponseCodesList

      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) = { ... }
      Returns:
      A list containing the redirectResponseCodes.
    • getRedirectResponseCodesCount

      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) = { ... }
      Returns:
      The count of redirectResponseCodes.
    • getRedirectResponseCodes

      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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The redirectResponseCodes at the given index.
    • getPredicatesList

      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;
    • getPredicates

      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;
    • getPredicatesCount

      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;
    • getPredicatesOrBuilderList

      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;
    • getPredicatesOrBuilder

      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;
    • getAllowCrossSchemeRedirect

      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;
      Returns:
      The allowCrossSchemeRedirect.
    • getResponseHeadersToCopyList

      List<String> getResponseHeadersToCopyList()
       Specifies a list of headers, by name, to copy from the internal redirect into the subsequent
       request. If a header is specified here but not present in the redirect, it will be cleared in
       the subsequent request.
       
      repeated string response_headers_to_copy = 5 [(.validate.rules) = { ... }
      Returns:
      A list containing the responseHeadersToCopy.
    • getResponseHeadersToCopyCount

      int getResponseHeadersToCopyCount()
       Specifies a list of headers, by name, to copy from the internal redirect into the subsequent
       request. If a header is specified here but not present in the redirect, it will be cleared in
       the subsequent request.
       
      repeated string response_headers_to_copy = 5 [(.validate.rules) = { ... }
      Returns:
      The count of responseHeadersToCopy.
    • getResponseHeadersToCopy

      String getResponseHeadersToCopy(int index)
       Specifies a list of headers, by name, to copy from the internal redirect into the subsequent
       request. If a header is specified here but not present in the redirect, it will be cleared in
       the subsequent request.
       
      repeated string response_headers_to_copy = 5 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The responseHeadersToCopy at the given index.
    • getResponseHeadersToCopyBytes

      com.google.protobuf.ByteString getResponseHeadersToCopyBytes(int index)
       Specifies a list of headers, by name, to copy from the internal redirect into the subsequent
       request. If a header is specified here but not present in the redirect, it will be cleared in
       the subsequent request.
       
      repeated string response_headers_to_copy = 5 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the responseHeadersToCopy at the given index.