Package io.envoyproxy.envoy.config.route.v3

Class RouteAction.HashPolicy.Cookie

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.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.GeneratedMessage 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.config.route.v3.RouteAction.HashPolicy.Cookie
See Also:

  • Field Details

  • Constructor Details

    • Cookie

      private Cookie(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • Cookie

      private Cookie()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • 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.

    • getAttributesList

      public List<RouteAction.HashPolicy.CookieAttribute> getAttributesList()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.config.route.v3.RouteAction.HashPolicy.CookieAttribute attributes = 4;
      Specified by:
      getAttributesList in interface RouteAction.HashPolicy.CookieOrBuilder

    • getAttributesOrBuilderList

      public List<? extends RouteAction.HashPolicy.CookieAttributeOrBuilder> getAttributesOrBuilderList()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.config.route.v3.RouteAction.HashPolicy.CookieAttribute attributes = 4;
      Specified by:
      getAttributesOrBuilderList in interface RouteAction.HashPolicy.CookieOrBuilder

    • getAttributesCount

      public int getAttributesCount()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.config.route.v3.RouteAction.HashPolicy.CookieAttribute attributes = 4;
      Specified by:
      getAttributesCount in interface RouteAction.HashPolicy.CookieOrBuilder

    • getAttributes

      public RouteAction.HashPolicy.CookieAttribute getAttributes(int index)
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.config.route.v3.RouteAction.HashPolicy.CookieAttribute attributes = 4;
      Specified by:
      getAttributes in interface RouteAction.HashPolicy.CookieOrBuilder

    • getAttributesOrBuilder

      public RouteAction.HashPolicy.CookieAttributeOrBuilder getAttributesOrBuilder(int index)
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.config.route.v3.RouteAction.HashPolicy.CookieAttribute attributes = 4;
      Specified by:
      getAttributesOrBuilder in interface RouteAction.HashPolicy.CookieOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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