stateful_session

package

v1.17.0-rc8 Latest Latest Go to latest Published: Jun 26, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/solo-io/gloo

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var File_github_com_solo_io_gloo_projects_gloo_api_v1_enterprise_options_stateful_session_stateful_session_proto protoreflect.FileDescriptor

Functions ¶

This section is empty.

Types ¶

type CookieBasedSessionState ¶

type CookieBasedSessionState struct {

	// Required, the cookie configuration used to track session state.
	Cookie *CookieBasedSessionState_Cookie `protobuf:"bytes,1,opt,name=cookie,proto3" json:"cookie,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the [cookie-based session state](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/cookie/v3/cookie.proto#envoy-v3-api-msg-extensions-http-stateful-session-cookie-v3-cookiebasedsessionstate) filter

func (*CookieBasedSessionState) Descriptor deprecated

func (*CookieBasedSessionState) Descriptor() ([]byte, []int)

Deprecated: Use CookieBasedSessionState.ProtoReflect.Descriptor instead.

func (*CookieBasedSessionState) GetCookie ¶

func (x *CookieBasedSessionState) GetCookie() *CookieBasedSessionState_Cookie

func (*CookieBasedSessionState) ProtoMessage ¶

func (*CookieBasedSessionState) ProtoMessage()

func (*CookieBasedSessionState) ProtoReflect ¶

func (x *CookieBasedSessionState) ProtoReflect() protoreflect.Message

func (*CookieBasedSessionState) Reset ¶

func (x *CookieBasedSessionState) Reset()

func (*CookieBasedSessionState) String ¶

func (x *CookieBasedSessionState) String() string

type CookieBasedSessionState_Cookie ¶

type CookieBasedSessionState_Cookie struct {

	// Required, the name that will be used to obtain cookie value from downstream HTTP request or generate new cookie for downstream.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Path of cookie. This will be used to set the path of a new cookie when it is generated. If no path is specified here, no path will be set for the cookie.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Duration of cookie. This will be used to set the expiry time of a new cookie when it is generated. Set this to 0s to use a session cookie and disable cookie expiration.
	Ttl *duration.Duration `protobuf:"bytes,3,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// contains filtered or unexported fields
}

func (*CookieBasedSessionState_Cookie) Descriptor deprecated

func (*CookieBasedSessionState_Cookie) Descriptor() ([]byte, []int)

Deprecated: Use CookieBasedSessionState_Cookie.ProtoReflect.Descriptor instead.

func (*CookieBasedSessionState_Cookie) GetName ¶

func (x *CookieBasedSessionState_Cookie) GetName() string

func (*CookieBasedSessionState_Cookie) GetPath ¶

func (x *CookieBasedSessionState_Cookie) GetPath() string

func (*CookieBasedSessionState_Cookie) GetTtl ¶

func (x *CookieBasedSessionState_Cookie) GetTtl() *duration.Duration

func (*CookieBasedSessionState_Cookie) ProtoMessage ¶

func (*CookieBasedSessionState_Cookie) ProtoMessage()

func (*CookieBasedSessionState_Cookie) ProtoReflect ¶

func (x *CookieBasedSessionState_Cookie) ProtoReflect() protoreflect.Message

func (*CookieBasedSessionState_Cookie) Reset ¶

func (x *CookieBasedSessionState_Cookie) Reset()

func (*CookieBasedSessionState_Cookie) String ¶

func (x *CookieBasedSessionState_Cookie) String() string

type HeaderBasedSessionState ¶

type HeaderBasedSessionState struct {

	// Required, the header used to track session state.
	HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the [header-based session state](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/header/v3/header.proto#extension-envoy-http-stateful-session-header) filter

func (*HeaderBasedSessionState) Descriptor deprecated

func (*HeaderBasedSessionState) Descriptor() ([]byte, []int)

Deprecated: Use HeaderBasedSessionState.ProtoReflect.Descriptor instead.

func (*HeaderBasedSessionState) GetHeaderName ¶

func (x *HeaderBasedSessionState) GetHeaderName() string

func (*HeaderBasedSessionState) ProtoMessage ¶

func (*HeaderBasedSessionState) ProtoMessage()

func (*HeaderBasedSessionState) ProtoReflect ¶

func (x *HeaderBasedSessionState) ProtoReflect() protoreflect.Message

func (*HeaderBasedSessionState) Reset ¶

func (x *HeaderBasedSessionState) Reset()

func (*HeaderBasedSessionState) String ¶

func (x *HeaderBasedSessionState) String() string

type StatefulSession ¶

type StatefulSession struct {

	// Types that are assignable to SessionState:
	//
	//	*StatefulSession_CookieBased
	//	*StatefulSession_HeaderBased
	SessionState isStatefulSession_SessionState `protobuf_oneof:"SessionState"`
	// If set to True, the HTTP request must be routed to the requested destination. If the requested destination is not available, Envoy returns 503. Defaults to False.
	Strict bool `protobuf:"varint,3,opt,name=strict,proto3" json:"strict,omitempty"`
	// contains filtered or unexported fields
}

This configures the Envoy [Stateful Session](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/stateful_session_filter) filter for a listener

func (*StatefulSession) Descriptor deprecated

func (*StatefulSession) Descriptor() ([]byte, []int)

Deprecated: Use StatefulSession.ProtoReflect.Descriptor instead.

func (*StatefulSession) GetCookieBased ¶

func (x *StatefulSession) GetCookieBased() *CookieBasedSessionState

func (*StatefulSession) GetHeaderBased ¶

func (x *StatefulSession) GetHeaderBased() *HeaderBasedSessionState

func (*StatefulSession) GetSessionState ¶

func (m *StatefulSession) GetSessionState() isStatefulSession_SessionState

func (*StatefulSession) GetStrict ¶

func (x *StatefulSession) GetStrict() bool

func (*StatefulSession) ProtoMessage ¶

func (*StatefulSession) ProtoMessage()

func (*StatefulSession) ProtoReflect ¶

func (x *StatefulSession) ProtoReflect() protoreflect.Message

func (*StatefulSession) Reset ¶

func (x *StatefulSession) Reset()

func (*StatefulSession) String ¶

func (x *StatefulSession) String() string

type StatefulSession_CookieBased ¶

type StatefulSession_CookieBased struct {
	// Configure a cookie based session state - https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/cookie/v3/cookie.proto#envoy-v3-api-msg-extensions-http-stateful-session-cookie-v3-cookiebasedsessionstate
	// Exactly one of `cookie_based` or `header_based` must be set.
	CookieBased *CookieBasedSessionState `protobuf:"bytes,1,opt,name=cookie_based,json=cookieBased,proto3,oneof"`
}

type StatefulSession_HeaderBased ¶

type StatefulSession_HeaderBased struct {
	// Configure a header based session state - https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/cookie/v3/cookie.proto#envoy-v3-api-msg-extensions-http-stateful-session-cookie-v3-cookiebasedsessionstate
	// Exactly one of `cookie_based` or `header_based` must be set.
	HeaderBased *HeaderBasedSessionState `protobuf:"bytes,2,opt,name=header_based,json=headerBased,proto3,oneof"`
}

Source Files ¶

View all Source files

stateful_session.pb.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL