Class InternalRedirectPolicy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.InternalRedirectPolicy
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,InternalRedirectPolicyOrBuilder
,Serializable
public final class InternalRedirectPolicy
extends com.google.protobuf.GeneratedMessage
implements InternalRedirectPolicyOrBuilder
HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`. [#next-free-field: 6]Protobuf type
envoy.config.route.v3.InternalRedirectPolicy
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private boolean
private int
private static final InternalRedirectPolicy
static final int
private com.google.protobuf.UInt32Value
private byte
private static final com.google.protobuf.Parser
<InternalRedirectPolicy> private List
<TypedExtensionConfig> static final int
static final int
private com.google.protobuf.Internal.IntList
private int
static final int
private com.google.protobuf.LazyStringArrayList
private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
InternalRedirectPolicy
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
Allow internal redirect to follow a target URI with a different scheme than the value of x-forwarded-proto.static InternalRedirectPolicy
static final com.google.protobuf.Descriptors.Descriptor
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.com.google.protobuf.Parser
<InternalRedirectPolicy> 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.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.List
<? extends TypedExtensionConfigOrBuilder> Specifies a list of predicates that are queried when an upstream response is deemed to trigger an internal redirect by all other criteria.int
getRedirectResponseCodes
(int index) 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.getResponseHeadersToCopy
(int index) Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.com.google.protobuf.ByteString
getResponseHeadersToCopyBytes
(int index) 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.com.google.protobuf.ProtocolStringList
Specifies a list of headers, by name, to copy from the internal redirect into the subsequent request.int
int
hashCode()
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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(InternalRedirectPolicy prototype) protected InternalRedirectPolicy.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static InternalRedirectPolicy
parseDelimitedFrom
(InputStream input) static InternalRedirectPolicy
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InternalRedirectPolicy
parseFrom
(byte[] data) static InternalRedirectPolicy
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InternalRedirectPolicy
parseFrom
(com.google.protobuf.ByteString data) static InternalRedirectPolicy
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InternalRedirectPolicy
parseFrom
(com.google.protobuf.CodedInputStream input) static InternalRedirectPolicy
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InternalRedirectPolicy
parseFrom
(InputStream input) static InternalRedirectPolicy
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InternalRedirectPolicy
parseFrom
(ByteBuffer data) static InternalRedirectPolicy
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<InternalRedirectPolicy> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
MAX_INTERNAL_REDIRECTS_FIELD_NUMBER
public static final int MAX_INTERNAL_REDIRECTS_FIELD_NUMBER- See Also:
-
maxInternalRedirects_
private com.google.protobuf.UInt32Value maxInternalRedirects_ -
REDIRECT_RESPONSE_CODES_FIELD_NUMBER
public static final int REDIRECT_RESPONSE_CODES_FIELD_NUMBER- See Also:
-
redirectResponseCodes_
private com.google.protobuf.Internal.IntList redirectResponseCodes_ -
redirectResponseCodesMemoizedSerializedSize
private int redirectResponseCodesMemoizedSerializedSize -
PREDICATES_FIELD_NUMBER
public static final int PREDICATES_FIELD_NUMBER- See Also:
-
predicates_
-
ALLOW_CROSS_SCHEME_REDIRECT_FIELD_NUMBER
public static final int ALLOW_CROSS_SCHEME_REDIRECT_FIELD_NUMBER- See Also:
-
allowCrossSchemeRedirect_
private boolean allowCrossSchemeRedirect_ -
RESPONSE_HEADERS_TO_COPY_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_COPY_FIELD_NUMBER- See Also:
-
responseHeadersToCopy_
private com.google.protobuf.LazyStringArrayList responseHeadersToCopy_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
InternalRedirectPolicy
private InternalRedirectPolicy(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
InternalRedirectPolicy
private InternalRedirectPolicy()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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 interfaceInternalRedirectPolicyOrBuilder
- 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 interfaceInternalRedirectPolicyOrBuilder
- Returns:
- The maxInternalRedirects.
-
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 interfaceInternalRedirectPolicyOrBuilder
-
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 interfaceInternalRedirectPolicyOrBuilder
- 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 interfaceInternalRedirectPolicyOrBuilder
- 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 interfaceInternalRedirectPolicyOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The redirectResponseCodes at the given index.
-
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 interfaceInternalRedirectPolicyOrBuilder
-
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 interfaceInternalRedirectPolicyOrBuilder
-
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 interfaceInternalRedirectPolicyOrBuilder
-
getPredicates
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 interfaceInternalRedirectPolicyOrBuilder
-
getPredicatesOrBuilder
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 interfaceInternalRedirectPolicyOrBuilder
-
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 interfaceInternalRedirectPolicyOrBuilder
- Returns:
- The allowCrossSchemeRedirect.
-
getResponseHeadersToCopyList
public com.google.protobuf.ProtocolStringList 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) = { ... }
- Specified by:
getResponseHeadersToCopyList
in interfaceInternalRedirectPolicyOrBuilder
- Returns:
- A list containing the responseHeadersToCopy.
-
getResponseHeadersToCopyCount
public 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) = { ... }
- Specified by:
getResponseHeadersToCopyCount
in interfaceInternalRedirectPolicyOrBuilder
- Returns:
- The count of responseHeadersToCopy.
-
getResponseHeadersToCopy
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) = { ... }
- Specified by:
getResponseHeadersToCopy
in interfaceInternalRedirectPolicyOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The responseHeadersToCopy at the given index.
-
getResponseHeadersToCopyBytes
public 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) = { ... }
- Specified by:
getResponseHeadersToCopyBytes
in interfaceInternalRedirectPolicyOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the responseHeadersToCopy at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static InternalRedirectPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InternalRedirectPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InternalRedirectPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InternalRedirectPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InternalRedirectPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InternalRedirectPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static InternalRedirectPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static InternalRedirectPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static InternalRedirectPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static InternalRedirectPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected InternalRedirectPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-