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

Interface StatefulSessionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StatefulSession, StatefulSession.Builder
public interface StatefulSessionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    hasSessionState()
    Specifies the implementation of session state.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasSessionState

      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;
      Returns:
      Whether the sessionState field is set.

    • getSessionState

      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;
      Returns:
      The sessionState.

    • getSessionStateOrBuilder

      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;

    • getStrict

      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;
      Returns:
      The strict.

    • getStatPrefix

      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;
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      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;
      Returns:
      The bytes for statPrefix.