Class RouteAction.HashPolicy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.route.v3.RouteAction.HashPolicy
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RouteAction.HashPolicyOrBuilder
,java.io.Serializable
- Enclosing class:
- RouteAction
public static final class RouteAction.HashPolicy extends com.google.protobuf.GeneratedMessage implements RouteAction.HashPolicyOrBuilder
Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`. [#next-free-field: 7]
Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RouteAction.HashPolicy.Builder
Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`.static class
RouteAction.HashPolicy.ConnectionProperties
Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.ConnectionProperties
static interface
RouteAction.HashPolicy.ConnectionPropertiesOrBuilder
static class
RouteAction.HashPolicy.Cookie
Envoy supports two types of cookie affinity: 1.static class
RouteAction.HashPolicy.CookieAttribute
CookieAttribute defines an API for adding additional attributes for a HTTP cookie.static interface
RouteAction.HashPolicy.CookieAttributeOrBuilder
static interface
RouteAction.HashPolicy.CookieOrBuilder
static class
RouteAction.HashPolicy.FilterState
Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.FilterState
static interface
RouteAction.HashPolicy.FilterStateOrBuilder
static class
RouteAction.HashPolicy.Header
Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.Header
static interface
RouteAction.HashPolicy.HeaderOrBuilder
static class
RouteAction.HashPolicy.PolicySpecifierCase
static class
RouteAction.HashPolicy.QueryParameter
Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.QueryParameter
static interface
RouteAction.HashPolicy.QueryParameterOrBuilder
-
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
CONNECTION_PROPERTIES_FIELD_NUMBER
static int
COOKIE_FIELD_NUMBER
private static RouteAction.HashPolicy
DEFAULT_INSTANCE
static int
FILTER_STATE_FIELD_NUMBER
static int
HEADER_FIELD_NUMBER
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<RouteAction.HashPolicy>
PARSER
private java.lang.Object
policySpecifier_
private int
policySpecifierCase_
static int
QUERY_PARAMETER_FIELD_NUMBER
private static long
serialVersionUID
private boolean
terminal_
static int
TERMINAL_FIELD_NUMBER
-
Constructor Summary
Constructors Modifier Constructor Description private
HashPolicy()
private
HashPolicy(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
RouteAction.HashPolicy.ConnectionProperties
getConnectionProperties()
Connection properties hash policy.RouteAction.HashPolicy.ConnectionPropertiesOrBuilder
getConnectionPropertiesOrBuilder()
Connection properties hash policy.RouteAction.HashPolicy.Cookie
getCookie()
Cookie hash policy.RouteAction.HashPolicy.CookieOrBuilder
getCookieOrBuilder()
Cookie hash policy.static RouteAction.HashPolicy
getDefaultInstance()
RouteAction.HashPolicy
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
RouteAction.HashPolicy.FilterState
getFilterState()
Filter state hash policy.RouteAction.HashPolicy.FilterStateOrBuilder
getFilterStateOrBuilder()
Filter state hash policy.RouteAction.HashPolicy.Header
getHeader()
Header hash policy.RouteAction.HashPolicy.HeaderOrBuilder
getHeaderOrBuilder()
Header hash policy.com.google.protobuf.Parser<RouteAction.HashPolicy>
getParserForType()
RouteAction.HashPolicy.PolicySpecifierCase
getPolicySpecifierCase()
RouteAction.HashPolicy.QueryParameter
getQueryParameter()
Query parameter hash policy.RouteAction.HashPolicy.QueryParameterOrBuilder
getQueryParameterOrBuilder()
Query parameter hash policy.int
getSerializedSize()
boolean
getTerminal()
The flag that short-circuits the hash computing.boolean
hasConnectionProperties()
Connection properties hash policy.boolean
hasCookie()
Cookie hash policy.boolean
hasFilterState()
Filter state hash policy.int
hashCode()
boolean
hasHeader()
Header hash policy.boolean
hasQueryParameter()
Query parameter hash policy.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RouteAction.HashPolicy.Builder
newBuilder()
static RouteAction.HashPolicy.Builder
newBuilder(RouteAction.HashPolicy prototype)
RouteAction.HashPolicy.Builder
newBuilderForType()
protected RouteAction.HashPolicy.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RouteAction.HashPolicy
parseDelimitedFrom(java.io.InputStream input)
static RouteAction.HashPolicy
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.HashPolicy
parseFrom(byte[] data)
static RouteAction.HashPolicy
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.HashPolicy
parseFrom(com.google.protobuf.ByteString data)
static RouteAction.HashPolicy
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.HashPolicy
parseFrom(com.google.protobuf.CodedInputStream input)
static RouteAction.HashPolicy
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.HashPolicy
parseFrom(java.io.InputStream input)
static RouteAction.HashPolicy
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.HashPolicy
parseFrom(java.nio.ByteBuffer data)
static RouteAction.HashPolicy
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RouteAction.HashPolicy>
parser()
RouteAction.HashPolicy.Builder
toBuilder()
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
policySpecifierCase_
private int policySpecifierCase_
-
policySpecifier_
private java.lang.Object policySpecifier_
-
HEADER_FIELD_NUMBER
public static final int HEADER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COOKIE_FIELD_NUMBER
public static final int COOKIE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONNECTION_PROPERTIES_FIELD_NUMBER
public static final int CONNECTION_PROPERTIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUERY_PARAMETER_FIELD_NUMBER
public static final int QUERY_PARAMETER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_STATE_FIELD_NUMBER
public static final int FILTER_STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TERMINAL_FIELD_NUMBER
public static final int TERMINAL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
terminal_
private boolean terminal_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final RouteAction.HashPolicy DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RouteAction.HashPolicy> PARSER
-
-
Method Detail
-
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
-
getPolicySpecifierCase
public RouteAction.HashPolicy.PolicySpecifierCase getPolicySpecifierCase()
- Specified by:
getPolicySpecifierCase
in interfaceRouteAction.HashPolicyOrBuilder
-
hasHeader
public boolean hasHeader()
Header hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Header header = 1;
- Specified by:
hasHeader
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- Whether the header field is set.
-
getHeader
public RouteAction.HashPolicy.Header getHeader()
Header hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Header header = 1;
- Specified by:
getHeader
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The header.
-
getHeaderOrBuilder
public RouteAction.HashPolicy.HeaderOrBuilder getHeaderOrBuilder()
Header hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Header header = 1;
- Specified by:
getHeaderOrBuilder
in interfaceRouteAction.HashPolicyOrBuilder
-
hasCookie
public boolean hasCookie()
Cookie hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Cookie cookie = 2;
- Specified by:
hasCookie
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- Whether the cookie field is set.
-
getCookie
public RouteAction.HashPolicy.Cookie getCookie()
Cookie hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Cookie cookie = 2;
- Specified by:
getCookie
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The cookie.
-
getCookieOrBuilder
public RouteAction.HashPolicy.CookieOrBuilder getCookieOrBuilder()
Cookie hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.Cookie cookie = 2;
- Specified by:
getCookieOrBuilder
in interfaceRouteAction.HashPolicyOrBuilder
-
hasConnectionProperties
public boolean hasConnectionProperties()
Connection properties hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;
- Specified by:
hasConnectionProperties
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- Whether the connectionProperties field is set.
-
getConnectionProperties
public RouteAction.HashPolicy.ConnectionProperties getConnectionProperties()
Connection properties hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;
- Specified by:
getConnectionProperties
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The connectionProperties.
-
getConnectionPropertiesOrBuilder
public RouteAction.HashPolicy.ConnectionPropertiesOrBuilder getConnectionPropertiesOrBuilder()
Connection properties hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;
- Specified by:
getConnectionPropertiesOrBuilder
in interfaceRouteAction.HashPolicyOrBuilder
-
hasQueryParameter
public boolean hasQueryParameter()
Query parameter hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.QueryParameter query_parameter = 5;
- Specified by:
hasQueryParameter
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- Whether the queryParameter field is set.
-
getQueryParameter
public RouteAction.HashPolicy.QueryParameter getQueryParameter()
Query parameter hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.QueryParameter query_parameter = 5;
- Specified by:
getQueryParameter
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The queryParameter.
-
getQueryParameterOrBuilder
public RouteAction.HashPolicy.QueryParameterOrBuilder getQueryParameterOrBuilder()
Query parameter hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.QueryParameter query_parameter = 5;
- Specified by:
getQueryParameterOrBuilder
in interfaceRouteAction.HashPolicyOrBuilder
-
hasFilterState
public boolean hasFilterState()
Filter state hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.FilterState filter_state = 6;
- Specified by:
hasFilterState
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- Whether the filterState field is set.
-
getFilterState
public RouteAction.HashPolicy.FilterState getFilterState()
Filter state hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.FilterState filter_state = 6;
- Specified by:
getFilterState
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The filterState.
-
getFilterStateOrBuilder
public RouteAction.HashPolicy.FilterStateOrBuilder getFilterStateOrBuilder()
Filter state hash policy.
.envoy.config.route.v3.RouteAction.HashPolicy.FilterState filter_state = 6;
- Specified by:
getFilterStateOrBuilder
in interfaceRouteAction.HashPolicyOrBuilder
-
getTerminal
public boolean getTerminal()
The flag that short-circuits the hash computing. This field provides a 'fallback' style of configuration: "if a terminal policy doesn't work, fallback to rest of the policy list", it saves time when the terminal policy works. If true, and there is already a hash computed, ignore rest of the list of hash polices. For example, if the following hash methods are configured: ========= ======== specifier terminal ========= ======== Header A true Header B false Header C false ========= ======== The generateHash process ends if policy "header A" generates a hash, as it's a terminal policy.
bool terminal = 4;
- Specified by:
getTerminal
in interfaceRouteAction.HashPolicyOrBuilder
- Returns:
- The terminal.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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 RouteAction.HashPolicy parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RouteAction.HashPolicy parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RouteAction.HashPolicy parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RouteAction.HashPolicy.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RouteAction.HashPolicy.Builder newBuilder()
-
newBuilder
public static RouteAction.HashPolicy.Builder newBuilder(RouteAction.HashPolicy prototype)
-
toBuilder
public RouteAction.HashPolicy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RouteAction.HashPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static RouteAction.HashPolicy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RouteAction.HashPolicy> parser()
-
getParserForType
public com.google.protobuf.Parser<RouteAction.HashPolicy> 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
public RouteAction.HashPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-