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

Class StatefulSession

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.stateful_session.v3.StatefulSession
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatefulSessionOrBuilder, Serializable
public final class StatefulSession extends com.google.protobuf.GeneratedMessageV3 implements StatefulSessionOrBuilder
Protobuf type envoy.extensions.filters.http.stateful_session.v3.StatefulSession
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StatefulSession.Builder
    Protobuf type envoy.extensions.filters.http.stateful_session.v3.StatefulSession

    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
    SESSION_STATE_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_FIELD_NUMBER
     
    static final int
    STRICT_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 StatefulSession
    getDefaultInstance()
     
    StatefulSession
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<StatefulSession>
    getParserForType()
     
    int
    getSerializedSize()
     
    TypedExtensionConfig
    getSessionState()
    Specifies the implementation of session state.
    TypedExtensionConfigOrBuilder
    getSessionStateOrBuilder()
    Specifies the implementation of session state.
    String
    getStatPrefix()
    Optional stat prefix.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    Optional stat prefix.
    boolean
    getStrict()
    Determines whether the HTTP request must be strictly routed to the requested destination.
    int
    hashCode()
     
    boolean
    hasSessionState()
    Specifies the implementation of session state.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StatefulSession.Builder
    newBuilder()
     
    static StatefulSession.Builder
    newBuilder(StatefulSession prototype)
     
    StatefulSession.Builder
    newBuilderForType()
     
    protected StatefulSession.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static StatefulSession
    parseDelimitedFrom(InputStream input)
     
    static StatefulSession
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatefulSession
    parseFrom(byte[] data)
     
    static StatefulSession
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatefulSession
    parseFrom(com.google.protobuf.ByteString data)
     
    static StatefulSession
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatefulSession
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StatefulSession
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatefulSession
    parseFrom(InputStream input)
     
    static StatefulSession
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatefulSession
    parseFrom(ByteBuffer data)
     
    static StatefulSession
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StatefulSession>
    parser()
     
    StatefulSession.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

    • SESSION_STATE_FIELD_NUMBER

      public static final int SESSION_STATE_FIELD_NUMBER
      See Also:

    • STRICT_FIELD_NUMBER

      public static final int STRICT_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

  • 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

    • hasSessionState

      public boolean hasSessionState()
       Specifies the implementation of session state. This session state is used to store and retrieve the address of the
 upstream host assigned to the session.

 [#extension-category: envoy.http.stateful_session]
      .envoy.config.core.v3.TypedExtensionConfig session_state = 1;
      Specified by:
      hasSessionState in interface StatefulSessionOrBuilder
      Returns:
      Whether the sessionState field is set.

    • getSessionState

      public TypedExtensionConfig getSessionState()
       Specifies the implementation of session state. This session state is used to store and retrieve the address of the
 upstream host assigned to the session.

 [#extension-category: envoy.http.stateful_session]
      .envoy.config.core.v3.TypedExtensionConfig session_state = 1;
      Specified by:
      getSessionState in interface StatefulSessionOrBuilder
      Returns:
      The sessionState.

    • getSessionStateOrBuilder

      public TypedExtensionConfigOrBuilder getSessionStateOrBuilder()
       Specifies the implementation of session state. This session state is used to store and retrieve the address of the
 upstream host assigned to the session.

 [#extension-category: envoy.http.stateful_session]
      .envoy.config.core.v3.TypedExtensionConfig session_state = 1;
      Specified by:
      getSessionStateOrBuilder in interface StatefulSessionOrBuilder

    • getStrict

      public boolean getStrict()
       Determines whether the HTTP request must be strictly routed to the requested destination. When set to ``true``,
 if the requested destination is unavailable, Envoy will return a 503 status code. The default value is ``false``,
 which allows Envoy to fall back to its load balancing mechanism. In this case, if the requested destination is not
 found, the request will be routed according to the load balancing algorithm.
      bool strict = 2;
      Specified by:
      getStrict in interface StatefulSessionOrBuilder
      Returns:
      The strict.

    • getStatPrefix

      public String getStatPrefix()
       Optional stat prefix. If specified, the filter will emit statistics in the
 ``http.<stat_prefix>.stateful_session.<stat_prefix>.`` namespace. If not specified, no statistics will be emitted.

 .. note::

   Per-route configuration overrides do not support statistics and will not emit stats even if this field is set
   in the per-route config.
      string stat_prefix = 3;
      Specified by:
      getStatPrefix in interface StatefulSessionOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       Optional stat prefix. If specified, the filter will emit statistics in the
 ``http.<stat_prefix>.stateful_session.<stat_prefix>.`` namespace. If not specified, no statistics will be emitted.

 .. note::

   Per-route configuration overrides do not support statistics and will not emit stats even if this field is set
   in the per-route config.
      string stat_prefix = 3;
      Specified by:
      getStatPrefixBytes in interface StatefulSessionOrBuilder
      Returns:
      The bytes for statPrefix.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StatefulSession.Builder newBuilder()

    • newBuilder

      public static StatefulSession.Builder newBuilder(StatefulSession prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StatefulSession getDefaultInstance()

    • parser

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

    • getParserForType

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