public static final class RouteAction.HashPolicy.Cookie.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder> implements RouteAction.HashPolicy.CookieOrBuilder
Envoy supports two types of cookie affinity:
1. Passive. Envoy takes a cookie that's present in the cookies header and
hashes on its value.
2. Generated. Envoy generates and sets a cookie with an expiration (TTL)
on the first request from the client in its response to the client,
based on the endpoint the request gets sent to. The client then
presents this on the next and all subsequent requests. The hash of
this is sufficient to ensure these requests get sent to the same
endpoint. The cookie is generated by hashing the source and
destination ports and addresses so that multiple independent HTTP2
streams on the same connection will independently receive the same
cookie, even if they arrive at the Envoy simultaneously.
Protobuf type envoy.api.v2.route.RouteAction.HashPolicy.Cookie| Modifier and Type | Method and Description |
|---|---|
RouteAction.HashPolicy.Cookie.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RouteAction.HashPolicy.Cookie |
build() |
RouteAction.HashPolicy.Cookie |
buildPartial() |
RouteAction.HashPolicy.Cookie.Builder |
clear() |
RouteAction.HashPolicy.Cookie.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RouteAction.HashPolicy.Cookie.Builder |
clearName()
The name of the cookie that will be used to obtain the hash key.
|
RouteAction.HashPolicy.Cookie.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RouteAction.HashPolicy.Cookie.Builder |
clearPath()
The name of the path for the cookie.
|
RouteAction.HashPolicy.Cookie.Builder |
clearTtl()
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
RouteAction.HashPolicy.Cookie.Builder |
clone() |
RouteAction.HashPolicy.Cookie |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getName()
The name of the cookie that will be used to obtain the hash key.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the cookie that will be used to obtain the hash key.
|
String |
getPath()
The name of the path for the cookie.
|
com.google.protobuf.ByteString |
getPathBytes()
The name of the path for the cookie.
|
com.google.protobuf.Duration |
getTtl()
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
com.google.protobuf.Duration.Builder |
getTtlBuilder()
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
com.google.protobuf.DurationOrBuilder |
getTtlOrBuilder()
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
boolean |
hasTtl()
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RouteAction.HashPolicy.Cookie.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RouteAction.HashPolicy.Cookie.Builder |
mergeFrom(com.google.protobuf.Message other) |
RouteAction.HashPolicy.Cookie.Builder |
mergeFrom(RouteAction.HashPolicy.Cookie other) |
RouteAction.HashPolicy.Cookie.Builder |
mergeTtl(com.google.protobuf.Duration value)
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
RouteAction.HashPolicy.Cookie.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RouteAction.HashPolicy.Cookie.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RouteAction.HashPolicy.Cookie.Builder |
setName(String value)
The name of the cookie that will be used to obtain the hash key.
|
RouteAction.HashPolicy.Cookie.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The name of the cookie that will be used to obtain the hash key.
|
RouteAction.HashPolicy.Cookie.Builder |
setPath(String value)
The name of the path for the cookie.
|
RouteAction.HashPolicy.Cookie.Builder |
setPathBytes(com.google.protobuf.ByteString value)
The name of the path for the cookie.
|
RouteAction.HashPolicy.Cookie.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RouteAction.HashPolicy.Cookie.Builder |
setTtl(com.google.protobuf.Duration.Builder builderForValue)
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
RouteAction.HashPolicy.Cookie.Builder |
setTtl(com.google.protobuf.Duration value)
If specified, a cookie with the TTL will be generated if the cookie is
not present.
|
RouteAction.HashPolicy.Cookie.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RouteAction.HashPolicy.Cookie build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RouteAction.HashPolicy.Cookie buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RouteAction.HashPolicy.Cookie.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder mergeFrom(RouteAction.HashPolicy.Cookie other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public RouteAction.HashPolicy.Cookie.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RouteAction.HashPolicy.Cookie.Builder>IOExceptionpublic String getName()
The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.
string name = 1 [(.validate.rules) = { ... }getName in interface RouteAction.HashPolicy.CookieOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.
string name = 1 [(.validate.rules) = { ... }getNameBytes in interface RouteAction.HashPolicy.CookieOrBuilderpublic RouteAction.HashPolicy.Cookie.Builder setName(String value)
The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.
string name = 1 [(.validate.rules) = { ... }public RouteAction.HashPolicy.Cookie.Builder clearName()
The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.
string name = 1 [(.validate.rules) = { ... }public RouteAction.HashPolicy.Cookie.Builder setNameBytes(com.google.protobuf.ByteString value)
The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.
string name = 1 [(.validate.rules) = { ... }public boolean hasTtl()
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;hasTtl in interface RouteAction.HashPolicy.CookieOrBuilderpublic com.google.protobuf.Duration getTtl()
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;getTtl in interface RouteAction.HashPolicy.CookieOrBuilderpublic RouteAction.HashPolicy.Cookie.Builder setTtl(com.google.protobuf.Duration value)
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;public RouteAction.HashPolicy.Cookie.Builder setTtl(com.google.protobuf.Duration.Builder builderForValue)
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;public RouteAction.HashPolicy.Cookie.Builder mergeTtl(com.google.protobuf.Duration value)
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;public RouteAction.HashPolicy.Cookie.Builder clearTtl()
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;public com.google.protobuf.Duration.Builder getTtlBuilder()
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.
.google.protobuf.Duration ttl = 2;getTtlOrBuilder in interface RouteAction.HashPolicy.CookieOrBuilderpublic String getPath()
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
string path = 3;getPath in interface RouteAction.HashPolicy.CookieOrBuilderpublic com.google.protobuf.ByteString getPathBytes()
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
string path = 3;getPathBytes in interface RouteAction.HashPolicy.CookieOrBuilderpublic RouteAction.HashPolicy.Cookie.Builder setPath(String value)
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
string path = 3;public RouteAction.HashPolicy.Cookie.Builder clearPath()
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
string path = 3;public RouteAction.HashPolicy.Cookie.Builder setPathBytes(com.google.protobuf.ByteString value)
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
string path = 3;public final RouteAction.HashPolicy.Cookie.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>public final RouteAction.HashPolicy.Cookie.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.HashPolicy.Cookie.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.