Package io.envoyproxy.envoy.extensions.http.stateful_session.envelope.v3

Class EnvelopeSessionState

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EnvelopeSessionStateOrBuilder, Serializable
public final class EnvelopeSessionState extends com.google.protobuf.GeneratedMessageV3 implements EnvelopeSessionStateOrBuilder
 The extension allows the session state is tracked via existing session context that initialized
 by the upstream server. It assumes that the upstream server will generate the session context
 (like session id header or cookie) in the initial response of the session and the client will use
 the same session context in the subsequent requests without any modification.

 When processing the response from the upstream, Envoy will check if the response contains the
 session context. If the response contains the session context, no matter if it's a new session
 context or an existing one, Envoy will join it and the upstream host as new session context.

 When processing the request from the downstream, Envoy will check if the request contains the
 session context. If the request contains the session context, Envoy will strip the
 upstream host from the session context.

 [#extension: envoy.http.stateful_session.envelope]
Protobuf type envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EnvelopeSessionState.Builder
    The extension allows the session state is tracked via existing session context that initialized by the upstream server.
    static final class 
    EnvelopeSessionState.Header
    Protobuf type envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState.Header
    static interface 
    EnvelopeSessionState.HeaderOrBuilder
     

    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
    HEADER_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 EnvelopeSessionState
    getDefaultInstance()
     
    EnvelopeSessionState
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    EnvelopeSessionState.Header
    getHeader()
    Set the header config to track the session state.
    EnvelopeSessionState.HeaderOrBuilder
    getHeaderOrBuilder()
    Set the header config to track the session state.
    com.google.protobuf.Parser<EnvelopeSessionState>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasHeader()
    Set the header config to track the session state.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EnvelopeSessionState.Builder
    newBuilder()
     
    static EnvelopeSessionState.Builder
    newBuilder(EnvelopeSessionState prototype)
     
    EnvelopeSessionState.Builder
    newBuilderForType()
     
    protected EnvelopeSessionState.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static EnvelopeSessionState
    parseDelimitedFrom(InputStream input)
     
    static EnvelopeSessionState
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EnvelopeSessionState
    parseFrom(byte[] data)
     
    static EnvelopeSessionState
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EnvelopeSessionState
    parseFrom(com.google.protobuf.ByteString data)
     
    static EnvelopeSessionState
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EnvelopeSessionState
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EnvelopeSessionState
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EnvelopeSessionState
    parseFrom(InputStream input)
     
    static EnvelopeSessionState
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EnvelopeSessionState
    parseFrom(ByteBuffer data)
     
    static EnvelopeSessionState
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EnvelopeSessionState>
    parser()
     
    EnvelopeSessionState.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

    • hasHeader

      public boolean hasHeader()
       Set the header config to track the session state.
      .envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState.Header header = 1 [(.validate.rules) = { ... }
      Specified by:
      hasHeader in interface EnvelopeSessionStateOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public EnvelopeSessionState.Header getHeader()
       Set the header config to track the session state.
      .envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState.Header header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface EnvelopeSessionStateOrBuilder
      Returns:
      The header.

    • getHeaderOrBuilder

      public EnvelopeSessionState.HeaderOrBuilder getHeaderOrBuilder()
       Set the header config to track the session state.
      .envoy.extensions.http.stateful_session.envelope.v3.EnvelopeSessionState.Header header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeaderOrBuilder in interface EnvelopeSessionStateOrBuilder

    • 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 EnvelopeSessionState parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static EnvelopeSessionState parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnvelopeSessionState parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnvelopeSessionState parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static EnvelopeSessionState parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static EnvelopeSessionState parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static EnvelopeSessionState parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EnvelopeSessionState.Builder newBuilder()

    • newBuilder

      public static EnvelopeSessionState.Builder newBuilder(EnvelopeSessionState prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static EnvelopeSessionState getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EnvelopeSessionState> parser()

    • getParserForType

      public com.google.protobuf.Parser<EnvelopeSessionState> 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 EnvelopeSessionState getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder