set_filter_statev3

Documentation

Index

• Variables
• type FilterStateValue
  • func (*FilterStateValue) Descriptor() ([]byte, []int)
  • func (x *FilterStateValue) GetFactoryKey() string
  • func (x *FilterStateValue) GetFormatString() *v3.SubstitutionFormatString
  • func (m *FilterStateValue) GetKey() isFilterStateValue_Key
  • func (x *FilterStateValue) GetObjectKey() string
  • func (x *FilterStateValue) GetReadOnly() bool
  • func (x *FilterStateValue) GetSharedWithUpstream() FilterStateValue_SharedWithUpstream
  • func (x *FilterStateValue) GetSkipIfEmpty() bool
  • func (m *FilterStateValue) GetValue() isFilterStateValue_Value
  • func (*FilterStateValue) ProtoMessage()
  • func (x *FilterStateValue) ProtoReflect() protoreflect.Message
  • func (x *FilterStateValue) Reset()
  • func (x *FilterStateValue) String() string
• type FilterStateValue_FormatString
• type FilterStateValue_ObjectKey
• type FilterStateValue_SharedWithUpstream
  • func (FilterStateValue_SharedWithUpstream) Descriptor() protoreflect.EnumDescriptor
  • func (x FilterStateValue_SharedWithUpstream) Enum() *FilterStateValue_SharedWithUpstream
  • func (FilterStateValue_SharedWithUpstream) EnumDescriptor() ([]byte, []int)
  • func (x FilterStateValue_SharedWithUpstream) Number() protoreflect.EnumNumber
  • func (x FilterStateValue_SharedWithUpstream) String() string
  • func (FilterStateValue_SharedWithUpstream) Type() protoreflect.EnumType

Variables

var (
	FilterStateValue_SharedWithUpstream_name = map[int32]string{
		0: "NONE",
		1: "ONCE",
		2: "TRANSITIVE",
	}
	FilterStateValue_SharedWithUpstream_value = map[string]int32{
		"NONE":       0,
		"ONCE":       1,
		"TRANSITIVE": 2,
	}
)

Enum value maps for FilterStateValue_SharedWithUpstream.

var File_envoy_extensions_filters_common_set_filter_state_v3_value_proto protoreflect.FileDescriptor

Types

type FilterStateValue

type FilterStateValue struct {

	// Types that are assignable to Key:
	//
	//	*FilterStateValue_ObjectKey
	Key isFilterStateValue_Key `protobuf_oneof:"key"`
	// Optional filter object factory lookup key. See :ref:`the well-known filter state keys <well_known_filter_state>`
	// for a list of valid factory keys.
	FactoryKey string `protobuf:"bytes,6,opt,name=factory_key,json=factoryKey,proto3" json:"factory_key,omitempty"`
	// Types that are assignable to Value:
	//
	//	*FilterStateValue_FormatString
	Value isFilterStateValue_Value `protobuf_oneof:"value"`
	// If marked as read-only, the filter state key value is locked, and cannot
	// be overridden by any filter, including this filter.
	ReadOnly bool `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// Configures the object to be shared with the upstream internal connections. See :ref:`internal upstream
	// transport <config_internal_upstream_transport>` for more details on the filter state sharing with
	// the internal connections.
	SharedWithUpstream FilterStateValue_SharedWithUpstream `` /* 211-byte string literal not displayed */
	// Skip the update if the value evaluates to an empty string.
	// This option can be used to supply multiple alternatives for the same filter state object key.
	SkipIfEmpty bool `protobuf:"varint,5,opt,name=skip_if_empty,json=skipIfEmpty,proto3" json:"skip_if_empty,omitempty"`
	// contains filtered or unexported fields
}

A filter state key and value pair. [#next-free-field: 7]

func (*FilterStateValue) Descriptor

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

Deprecated: Use FilterStateValue.ProtoReflect.Descriptor instead.

func (*FilterStateValue) GetFactoryKey

func (x *FilterStateValue) GetFactoryKey() string

func (*FilterStateValue) GetFormatString

func (x *FilterStateValue) GetFormatString() *v3.SubstitutionFormatString

func (*FilterStateValue) GetKey

func (m *FilterStateValue) GetKey() isFilterStateValue_Key

func (*FilterStateValue) GetObjectKey

func (x *FilterStateValue) GetObjectKey() string

func (*FilterStateValue) GetReadOnly

func (x *FilterStateValue) GetReadOnly() bool

func (*FilterStateValue) GetSharedWithUpstream

func (x *FilterStateValue) GetSharedWithUpstream() FilterStateValue_SharedWithUpstream

func (*FilterStateValue) GetSkipIfEmpty

func (x *FilterStateValue) GetSkipIfEmpty() bool

func (*FilterStateValue) GetValue

func (m *FilterStateValue) GetValue() isFilterStateValue_Value

func (*FilterStateValue) ProtoMessage

func (*FilterStateValue) ProtoMessage()

func (*FilterStateValue) ProtoReflect

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

func (*FilterStateValue) Reset

func (x *FilterStateValue) Reset()

func (*FilterStateValue) String

func (x *FilterStateValue) String() string

type FilterStateValue_FormatString

type FilterStateValue_FormatString struct {
	// Uses the :ref:`format string <config_access_log_format_strings>` to
	// instantiate the filter state object value.
	FormatString *v3.SubstitutionFormatString `protobuf:"bytes,2,opt,name=format_string,json=formatString,proto3,oneof"`
}

type FilterStateValue_ObjectKey

type FilterStateValue_ObjectKey struct {
	// Filter state object key. The key is used to lookup the object factory, unless :ref:`factory_key
	// <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is set. See
	// :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid object keys.
	ObjectKey string `protobuf:"bytes,1,opt,name=object_key,json=objectKey,proto3,oneof"`
}

type FilterStateValue_SharedWithUpstream

type FilterStateValue_SharedWithUpstream int32

const (
	// Object is not shared with the upstream internal connections.
	FilterStateValue_NONE FilterStateValue_SharedWithUpstream = 0
	// Object is shared with the upstream internal connection.
	FilterStateValue_ONCE FilterStateValue_SharedWithUpstream = 1
	// Object is shared with the upstream internal connection and any internal connection upstream from it.
	FilterStateValue_TRANSITIVE FilterStateValue_SharedWithUpstream = 2
)

func (FilterStateValue_SharedWithUpstream) Descriptor

func (FilterStateValue_SharedWithUpstream) Descriptor() protoreflect.EnumDescriptor

func (FilterStateValue_SharedWithUpstream) Enum

func (x FilterStateValue_SharedWithUpstream) Enum() *FilterStateValue_SharedWithUpstream

func (FilterStateValue_SharedWithUpstream) EnumDescriptor

func (FilterStateValue_SharedWithUpstream) EnumDescriptor() ([]byte, []int)

Deprecated: Use FilterStateValue_SharedWithUpstream.Descriptor instead.

func (FilterStateValue_SharedWithUpstream) Number

func (x FilterStateValue_SharedWithUpstream) Number() protoreflect.EnumNumber

func (FilterStateValue_SharedWithUpstream) String

func (x FilterStateValue_SharedWithUpstream) String() string

func (FilterStateValue_SharedWithUpstream) Type

func (FilterStateValue_SharedWithUpstream) Type() protoreflect.EnumType