compressorv3

package
v1.33.0-20240426201503... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: unknown License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_filters_http_compressor_v3_compressor_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Compressor

type Compressor struct {

	// Minimum response length, in bytes, which will trigger compression. The default value is 30.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.
	ContentLength *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=content_length,json=contentLength,proto3" json:"content_length,omitempty"`
	// Set of strings that allows specifying which mime-types yield compression; e.g.,
	// application/json, text/html, etc. When this field is not defined, compression will be applied
	// to the following mime-types: "application/javascript", "application/json",
	// "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
	// and their synonyms.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.
	ContentType []string `protobuf:"bytes,2,rep,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// If true, disables compression when the response contains an etag header. When it is false, the
	// filter will preserve weak etags and remove the ones that require strong validation.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.
	DisableOnEtagHeader bool `protobuf:"varint,3,opt,name=disable_on_etag_header,json=disableOnEtagHeader,proto3" json:"disable_on_etag_header,omitempty"`
	// If true, removes accept-encoding from the request headers before dispatching it to the upstream
	// so that responses do not get compressed before reaching the filter.
	//
	// .. attention::
	//
	//	To avoid interfering with other compression filters in the same chain use this option in
	//	the filter closest to the upstream.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.
	RemoveAcceptEncodingHeader bool `` /* 144-byte string literal not displayed */
	// Runtime flag that controls whether the filter is enabled or not. If set to false, the
	// filter will operate as a pass-through filter, unless overridden by
	// CompressorPerRoute. If not specified, defaults to enabled.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.
	RuntimeEnabled *v3.RuntimeFeatureFlag `protobuf:"bytes,5,opt,name=runtime_enabled,json=runtimeEnabled,proto3" json:"runtime_enabled,omitempty"`
	// A compressor library to use for compression. Currently only
	// :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
	// is included in Envoy.
	// [#extension-category: envoy.compression.compressor]
	CompressorLibrary *v3.TypedExtensionConfig `protobuf:"bytes,6,opt,name=compressor_library,json=compressorLibrary,proto3" json:"compressor_library,omitempty"`
	// Configuration for request compression. Compression is disabled by default if left empty.
	RequestDirectionConfig *Compressor_RequestDirectionConfig `` /* 129-byte string literal not displayed */
	// Configuration for response compression. Compression is enabled by default if left empty.
	//
	// .. attention::
	//
	//	If the field is not empty then the duplicate deprecated fields of the “Compressor“ message,
	//	such as “content_length“, “content_type“, “disable_on_etag_header“,
	//	“remove_accept_encoding_header“ and “runtime_enabled“, are ignored.
	//
	//	Also all the statistics related to response compression will be rooted in
	//	“<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*“
	//	instead of
	//	“<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*“.
	ResponseDirectionConfig *Compressor_ResponseDirectionConfig `` /* 132-byte string literal not displayed */
	// If true, chooses this compressor first to do compression when the q-values in “Accept-Encoding“ are same.
	// The last compressor which enables choose_first will be chosen if multiple compressor filters in the chain have choose_first as true.
	ChooseFirst bool `protobuf:"varint,9,opt,name=choose_first,json=chooseFirst,proto3" json:"choose_first,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 10]

func (*Compressor) Descriptor deprecated

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

Deprecated: Use Compressor.ProtoReflect.Descriptor instead.

func (*Compressor) GetChooseFirst

func (x *Compressor) GetChooseFirst() bool

func (*Compressor) GetCompressorLibrary

func (x *Compressor) GetCompressorLibrary() *v3.TypedExtensionConfig

func (*Compressor) GetContentLength deprecated

func (x *Compressor) GetContentLength() *wrapperspb.UInt32Value

Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.

func (*Compressor) GetContentType deprecated

func (x *Compressor) GetContentType() []string

Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.

func (*Compressor) GetDisableOnEtagHeader deprecated

func (x *Compressor) GetDisableOnEtagHeader() bool

Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.

func (*Compressor) GetRemoveAcceptEncodingHeader deprecated

func (x *Compressor) GetRemoveAcceptEncodingHeader() bool

Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.

func (*Compressor) GetRequestDirectionConfig

func (x *Compressor) GetRequestDirectionConfig() *Compressor_RequestDirectionConfig

func (*Compressor) GetResponseDirectionConfig

func (x *Compressor) GetResponseDirectionConfig() *Compressor_ResponseDirectionConfig

func (*Compressor) GetRuntimeEnabled deprecated

func (x *Compressor) GetRuntimeEnabled() *v3.RuntimeFeatureFlag

Deprecated: Marked as deprecated in envoy/extensions/filters/http/compressor/v3/compressor.proto.

func (*Compressor) ProtoMessage

func (*Compressor) ProtoMessage()

func (*Compressor) ProtoReflect

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

func (*Compressor) Reset

func (x *Compressor) Reset()

func (*Compressor) String

func (x *Compressor) String() string

type CompressorOverrides

type CompressorOverrides struct {

	// If present, response compression is enabled.
	ResponseDirectionConfig *ResponseDirectionOverrides `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Per-route overrides. As per-route overrides are needed, they should be added here, mirroring the structure of “Compressor“. All fields should be optional, to allow overriding arbitrary subsets of configuration.

func (*CompressorOverrides) Descriptor deprecated

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

Deprecated: Use CompressorOverrides.ProtoReflect.Descriptor instead.

func (*CompressorOverrides) GetResponseDirectionConfig

func (x *CompressorOverrides) GetResponseDirectionConfig() *ResponseDirectionOverrides

func (*CompressorOverrides) ProtoMessage

func (*CompressorOverrides) ProtoMessage()

func (*CompressorOverrides) ProtoReflect

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

func (*CompressorOverrides) Reset

func (x *CompressorOverrides) Reset()

func (*CompressorOverrides) String

func (x *CompressorOverrides) String() string

type CompressorPerRoute

type CompressorPerRoute struct {

	// Types that are assignable to Override:
	//
	//	*CompressorPerRoute_Disabled
	//	*CompressorPerRoute_Overrides
	Override isCompressorPerRoute_Override `protobuf_oneof:"override"`
	// contains filtered or unexported fields
}

func (*CompressorPerRoute) Descriptor deprecated

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

Deprecated: Use CompressorPerRoute.ProtoReflect.Descriptor instead.

func (*CompressorPerRoute) GetDisabled

func (x *CompressorPerRoute) GetDisabled() bool

func (*CompressorPerRoute) GetOverride

func (m *CompressorPerRoute) GetOverride() isCompressorPerRoute_Override

func (*CompressorPerRoute) GetOverrides

func (x *CompressorPerRoute) GetOverrides() *CompressorOverrides

func (*CompressorPerRoute) ProtoMessage

func (*CompressorPerRoute) ProtoMessage()

func (*CompressorPerRoute) ProtoReflect

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

func (*CompressorPerRoute) Reset

func (x *CompressorPerRoute) Reset()

func (*CompressorPerRoute) String

func (x *CompressorPerRoute) String() string

type CompressorPerRoute_Disabled

type CompressorPerRoute_Disabled struct {
	// If set, the filter will operate as a pass-through filter.
	// Overrides Compressor.runtime_enabled and CommonDirectionConfig.enabled.
	Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3,oneof"`
}

type CompressorPerRoute_Overrides

type CompressorPerRoute_Overrides struct {
	// Per-route overrides. Fields set here will override corresponding fields in “Compressor“.
	Overrides *CompressorOverrides `protobuf:"bytes,2,opt,name=overrides,proto3,oneof"`
}

type Compressor_CommonDirectionConfig

type Compressor_CommonDirectionConfig struct {

	// Runtime flag that controls whether compression is enabled or not for the direction this
	// common config is put in. If set to false, the filter will operate as a pass-through filter
	// in the chosen direction, unless overridden by CompressorPerRoute.
	// If the field is omitted, the filter will be enabled.
	Enabled *v3.RuntimeFeatureFlag `protobuf:"bytes,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Minimum value of Content-Length header of request or response messages (depending on the direction
	// this common config is put in), in bytes, which will trigger compression. The default value is 30.
	MinContentLength *wrapperspb.UInt32Value `protobuf:"bytes,2,opt,name=min_content_length,json=minContentLength,proto3" json:"min_content_length,omitempty"`
	// Set of strings that allows specifying which mime-types yield compression; e.g.,
	// application/json, text/html, etc. When this field is not defined, compression will be applied
	// to the following mime-types: "application/javascript", "application/json",
	// "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
	// and their synonyms.
	ContentType []string `protobuf:"bytes,3,rep,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Compressor_CommonDirectionConfig) Descriptor deprecated

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

Deprecated: Use Compressor_CommonDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_CommonDirectionConfig) GetContentType

func (x *Compressor_CommonDirectionConfig) GetContentType() []string

func (*Compressor_CommonDirectionConfig) GetEnabled

func (*Compressor_CommonDirectionConfig) GetMinContentLength

func (x *Compressor_CommonDirectionConfig) GetMinContentLength() *wrapperspb.UInt32Value

func (*Compressor_CommonDirectionConfig) ProtoMessage

func (*Compressor_CommonDirectionConfig) ProtoMessage()

func (*Compressor_CommonDirectionConfig) ProtoReflect

func (*Compressor_CommonDirectionConfig) Reset

func (*Compressor_CommonDirectionConfig) String

type Compressor_RequestDirectionConfig

type Compressor_RequestDirectionConfig struct {
	CommonConfig *Compressor_CommonDirectionConfig `protobuf:"bytes,1,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for filter behavior on the request direction.

func (*Compressor_RequestDirectionConfig) Descriptor deprecated

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

Deprecated: Use Compressor_RequestDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_RequestDirectionConfig) GetCommonConfig

func (*Compressor_RequestDirectionConfig) ProtoMessage

func (*Compressor_RequestDirectionConfig) ProtoMessage()

func (*Compressor_RequestDirectionConfig) ProtoReflect

func (*Compressor_RequestDirectionConfig) Reset

func (*Compressor_RequestDirectionConfig) String

type Compressor_ResponseDirectionConfig

type Compressor_ResponseDirectionConfig struct {
	CommonConfig *Compressor_CommonDirectionConfig `protobuf:"bytes,1,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// If true, disables compression when the response contains an etag header. When it is false, the
	// filter will preserve weak etags and remove the ones that require strong validation.
	DisableOnEtagHeader bool `protobuf:"varint,2,opt,name=disable_on_etag_header,json=disableOnEtagHeader,proto3" json:"disable_on_etag_header,omitempty"`
	// If true, removes accept-encoding from the request headers before dispatching it to the upstream
	// so that responses do not get compressed before reaching the filter.
	//
	// .. attention::
	//
	//	To avoid interfering with other compression filters in the same chain use this option in
	//	the filter closest to the upstream.
	RemoveAcceptEncodingHeader bool `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for filter behavior on the response direction.

func (*Compressor_ResponseDirectionConfig) Descriptor deprecated

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

Deprecated: Use Compressor_ResponseDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_ResponseDirectionConfig) GetCommonConfig

func (*Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader

func (x *Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader() bool

func (*Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader

func (x *Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader() bool

func (*Compressor_ResponseDirectionConfig) ProtoMessage

func (*Compressor_ResponseDirectionConfig) ProtoMessage()

func (*Compressor_ResponseDirectionConfig) ProtoReflect

func (*Compressor_ResponseDirectionConfig) Reset

func (*Compressor_ResponseDirectionConfig) String

type ResponseDirectionOverrides

type ResponseDirectionOverrides struct {

	// If set, overrides the filter-level
	// :ref:`remove_accept_encoding_header<envoy_v3_api_field_extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig.remove_accept_encoding_header>`.
	RemoveAcceptEncodingHeader *wrapperspb.BoolValue `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Per-route overrides of “ResponseDirectionConfig“. Anything added here should be optional, to allow overriding arbitrary subsets of configuration. Omitted fields must have no effect.

func (*ResponseDirectionOverrides) Descriptor deprecated

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

Deprecated: Use ResponseDirectionOverrides.ProtoReflect.Descriptor instead.

func (*ResponseDirectionOverrides) GetRemoveAcceptEncodingHeader

func (x *ResponseDirectionOverrides) GetRemoveAcceptEncodingHeader() *wrapperspb.BoolValue

func (*ResponseDirectionOverrides) ProtoMessage

func (*ResponseDirectionOverrides) ProtoMessage()

func (*ResponseDirectionOverrides) ProtoReflect

func (*ResponseDirectionOverrides) Reset

func (x *ResponseDirectionOverrides) Reset()

func (*ResponseDirectionOverrides) String

func (x *ResponseDirectionOverrides) String() string

Jump to

Keyboard shortcuts

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