Package io.envoyproxy.envoy.api.v2.route

Class RouteAction.HashPolicy.Cookie

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.route.RouteAction.HashPolicy.Cookie
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.HashPolicy.CookieOrBuilder, Serializable
Enclosing class:
RouteAction.HashPolicy
public static final class RouteAction.HashPolicy.Cookie extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RouteAction.HashPolicy.Cookie.Builder
    Envoy supports two types of cookie affinity: 1.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    TTL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RouteAction.HashPolicy.Cookie
    getDefaultInstance()
     
    RouteAction.HashPolicy.Cookie
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<RouteAction.HashPolicy.Cookie>
    getParserForType()
     
    String
    getPath()
    The name of the path for the cookie.
    com.google.protobuf.ByteString
    getPathBytes()
    The name of the path for the cookie.
    int
    getSerializedSize()
     
    com.google.protobuf.Duration
    getTtl()
    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.
    int
    hashCode()
     
    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()
     
    final boolean
    isInitialized()
     
    static RouteAction.HashPolicy.Cookie.Builder
    newBuilder()
     
    static RouteAction.HashPolicy.Cookie.Builder
    newBuilder(RouteAction.HashPolicy.Cookie prototype)
     
    RouteAction.HashPolicy.Cookie.Builder
    newBuilderForType()
     
    protected RouteAction.HashPolicy.Cookie.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RouteAction.HashPolicy.Cookie
    parseDelimitedFrom(InputStream input)
     
    static RouteAction.HashPolicy.Cookie
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(byte[] data)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(com.google.protobuf.ByteString data)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(InputStream input)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(ByteBuffer data)
     
    static RouteAction.HashPolicy.Cookie
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RouteAction.HashPolicy.Cookie>
    parser()
     
    RouteAction.HashPolicy.Cookie.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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

    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

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      The bytes for name.

    • hasTtl

      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;
      Specified by:
      hasTtl in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      Whether the ttl field is set.

    • getTtl

      public 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;
      Specified by:
      getTtl in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      The ttl.

    • getTtlOrBuilder

      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;
      Specified by:
      getTtlOrBuilder in interface RouteAction.HashPolicy.CookieOrBuilder

    • getPath

      public 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;
      Specified by:
      getPath in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      The path.

    • getPathBytes

      public 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;
      Specified by:
      getPathBytes in interface RouteAction.HashPolicy.CookieOrBuilder
      Returns:
      The bytes for path.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie 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.Cookie parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RouteAction.HashPolicy.Cookie parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RouteAction.HashPolicy.Cookie parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RouteAction.HashPolicy.Cookie parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RouteAction.HashPolicy.Cookie.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RouteAction.HashPolicy.Cookie.Builder newBuilder()

    • newBuilder

      public static RouteAction.HashPolicy.Cookie.Builder newBuilder(RouteAction.HashPolicy.Cookie prototype)

    • toBuilder

      public RouteAction.HashPolicy.Cookie.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RouteAction.HashPolicy.Cookie.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RouteAction.HashPolicy.Cookie getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RouteAction.HashPolicy.Cookie> parser()

    • getParserForType

      public com.google.protobuf.Parser<RouteAction.HashPolicy.Cookie> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RouteAction.HashPolicy.Cookie getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder