Package io.envoyproxy.envoy.api.v2.route
Class RouteAction.HashPolicy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.envoyproxy.envoy.api.v2.route.RouteAction.HashPolicy
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,RouteAction.HashPolicyOrBuilder,Serializable
- Enclosing class:
- RouteAction
public static final class RouteAction.HashPolicy extends com.google.protobuf.GeneratedMessageV3 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.api.v2.route.RouteAction.HashPolicy- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRouteAction.HashPolicy.BuilderSpecifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`.static classRouteAction.HashPolicy.ConnectionPropertiesProtobuf typeenvoy.api.v2.route.RouteAction.HashPolicy.ConnectionPropertiesstatic interfaceRouteAction.HashPolicy.ConnectionPropertiesOrBuilderstatic classRouteAction.HashPolicy.CookieEnvoy supports two types of cookie affinity: 1.static interfaceRouteAction.HashPolicy.CookieOrBuilderstatic classRouteAction.HashPolicy.FilterStateProtobuf typeenvoy.api.v2.route.RouteAction.HashPolicy.FilterStatestatic interfaceRouteAction.HashPolicy.FilterStateOrBuilderstatic classRouteAction.HashPolicy.HeaderProtobuf typeenvoy.api.v2.route.RouteAction.HashPolicy.Headerstatic interfaceRouteAction.HashPolicy.HeaderOrBuilderstatic classRouteAction.HashPolicy.PolicySpecifierCasestatic classRouteAction.HashPolicy.QueryParameterProtobuf typeenvoy.api.v2.route.RouteAction.HashPolicy.QueryParameterstatic interfaceRouteAction.HashPolicy.QueryParameterOrBuilder-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intCONNECTION_PROPERTIES_FIELD_NUMBERstatic intCOOKIE_FIELD_NUMBERstatic intFILTER_STATE_FIELD_NUMBERstatic intHEADER_FIELD_NUMBERstatic intQUERY_PARAMETER_FIELD_NUMBERstatic intTERMINAL_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)RouteAction.HashPolicy.ConnectionPropertiesgetConnectionProperties()Connection properties hash policy.RouteAction.HashPolicy.ConnectionPropertiesOrBuildergetConnectionPropertiesOrBuilder()Connection properties hash policy.RouteAction.HashPolicy.CookiegetCookie()Cookie hash policy.RouteAction.HashPolicy.CookieOrBuildergetCookieOrBuilder()Cookie hash policy.static RouteAction.HashPolicygetDefaultInstance()RouteAction.HashPolicygetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()RouteAction.HashPolicy.FilterStategetFilterState()Filter state hash policy.RouteAction.HashPolicy.FilterStateOrBuildergetFilterStateOrBuilder()Filter state hash policy.RouteAction.HashPolicy.HeadergetHeader()Header hash policy.RouteAction.HashPolicy.HeaderOrBuildergetHeaderOrBuilder()Header hash policy.com.google.protobuf.Parser<RouteAction.HashPolicy>getParserForType()RouteAction.HashPolicy.PolicySpecifierCasegetPolicySpecifierCase()RouteAction.HashPolicy.QueryParametergetQueryParameter()Query parameter hash policy.RouteAction.HashPolicy.QueryParameterOrBuildergetQueryParameterOrBuilder()Query parameter hash policy.intgetSerializedSize()booleangetTerminal()The flag that short-circuits the hash computing.com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasConnectionProperties()Connection properties hash policy.booleanhasCookie()Cookie hash policy.booleanhasFilterState()Filter state hash policy.inthashCode()booleanhasHeader()Header hash policy.booleanhasQueryParameter()Query parameter hash policy.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static RouteAction.HashPolicy.BuildernewBuilder()static RouteAction.HashPolicy.BuildernewBuilder(RouteAction.HashPolicy prototype)RouteAction.HashPolicy.BuildernewBuilderForType()protected RouteAction.HashPolicy.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static RouteAction.HashPolicyparseDelimitedFrom(InputStream input)static RouteAction.HashPolicyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RouteAction.HashPolicyparseFrom(byte[] data)static RouteAction.HashPolicyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RouteAction.HashPolicyparseFrom(com.google.protobuf.ByteString data)static RouteAction.HashPolicyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RouteAction.HashPolicyparseFrom(com.google.protobuf.CodedInputStream input)static RouteAction.HashPolicyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RouteAction.HashPolicyparseFrom(InputStream input)static RouteAction.HashPolicyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RouteAction.HashPolicyparseFrom(ByteBuffer data)static RouteAction.HashPolicyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<RouteAction.HashPolicy>parser()RouteAction.HashPolicy.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getPolicySpecifierCase
public RouteAction.HashPolicy.PolicySpecifierCase getPolicySpecifierCase()
- Specified by:
getPolicySpecifierCasein interfaceRouteAction.HashPolicyOrBuilder
-
hasHeader
public boolean hasHeader()
Header hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Header header = 1;- Specified by:
hasHeaderin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- Whether the header field is set.
-
getHeader
public RouteAction.HashPolicy.Header getHeader()
Header hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Header header = 1;- Specified by:
getHeaderin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The header.
-
getHeaderOrBuilder
public RouteAction.HashPolicy.HeaderOrBuilder getHeaderOrBuilder()
Header hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Header header = 1;- Specified by:
getHeaderOrBuilderin interfaceRouteAction.HashPolicyOrBuilder
-
hasCookie
public boolean hasCookie()
Cookie hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Cookie cookie = 2;- Specified by:
hasCookiein interfaceRouteAction.HashPolicyOrBuilder- Returns:
- Whether the cookie field is set.
-
getCookie
public RouteAction.HashPolicy.Cookie getCookie()
Cookie hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Cookie cookie = 2;- Specified by:
getCookiein interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The cookie.
-
getCookieOrBuilder
public RouteAction.HashPolicy.CookieOrBuilder getCookieOrBuilder()
Cookie hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.Cookie cookie = 2;- Specified by:
getCookieOrBuilderin interfaceRouteAction.HashPolicyOrBuilder
-
hasConnectionProperties
public boolean hasConnectionProperties()
Connection properties hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;- Specified by:
hasConnectionPropertiesin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- Whether the connectionProperties field is set.
-
getConnectionProperties
public RouteAction.HashPolicy.ConnectionProperties getConnectionProperties()
Connection properties hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;- Specified by:
getConnectionPropertiesin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The connectionProperties.
-
getConnectionPropertiesOrBuilder
public RouteAction.HashPolicy.ConnectionPropertiesOrBuilder getConnectionPropertiesOrBuilder()
Connection properties hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.ConnectionProperties connection_properties = 3;- Specified by:
getConnectionPropertiesOrBuilderin interfaceRouteAction.HashPolicyOrBuilder
-
hasQueryParameter
public boolean hasQueryParameter()
Query parameter hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.QueryParameter query_parameter = 5;- Specified by:
hasQueryParameterin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- Whether the queryParameter field is set.
-
getQueryParameter
public RouteAction.HashPolicy.QueryParameter getQueryParameter()
Query parameter hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.QueryParameter query_parameter = 5;- Specified by:
getQueryParameterin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The queryParameter.
-
getQueryParameterOrBuilder
public RouteAction.HashPolicy.QueryParameterOrBuilder getQueryParameterOrBuilder()
Query parameter hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.QueryParameter query_parameter = 5;- Specified by:
getQueryParameterOrBuilderin interfaceRouteAction.HashPolicyOrBuilder
-
hasFilterState
public boolean hasFilterState()
Filter state hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.FilterState filter_state = 6;- Specified by:
hasFilterStatein interfaceRouteAction.HashPolicyOrBuilder- Returns:
- Whether the filterState field is set.
-
getFilterState
public RouteAction.HashPolicy.FilterState getFilterState()
Filter state hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.FilterState filter_state = 6;- Specified by:
getFilterStatein interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The filterState.
-
getFilterStateOrBuilder
public RouteAction.HashPolicy.FilterStateOrBuilder getFilterStateOrBuilder()
Filter state hash policy.
.envoy.api.v2.route.RouteAction.HashPolicy.FilterState filter_state = 6;- Specified by:
getFilterStateOrBuilderin 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:
getTerminalin interfaceRouteAction.HashPolicyOrBuilder- Returns:
- The terminal.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RouteAction.HashPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(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(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RouteAction.HashPolicy parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RouteAction.HashPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RouteAction.HashPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public RouteAction.HashPolicy.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein 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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RouteAction.HashPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RouteAction.HashPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-